Add User Group

Overview
Creates a user group with the specified User IDs.

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/addGroup.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID

Return
Returns the created User Group's ID if valid arguments are provided. Returns an error if not a valid request.

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="name"/>
        <xs:element ref="description"/>
        <xs:element ref="userList"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="description" type="xs:string" minOccurs="0"/>
  <xs:element name="userList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="userId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="userId" type="xs:integer"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Result"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="Result">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="UserGroup"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="UserGroup">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="Id"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="Id" type="xs:integer"/>
</xs:schema>

Curl Example

HTTP Method:	GET
Request:	curl -k -X POST 'https://www.mobiwork.com/api/rest/17800/10.0.80/user/addGroup.html?token=0FGPVHU0UR4H7TWEXPLW' \ --header 'Content-Type: application/xml' \ --header 'Cookie: JSESSIONID=149F3CABCBF9AFD355E716AB531F8BBD' \ --data-raw '<request> <name>Testing Group</name> <description>Testing Group</description> <userList> <userId>84330</userId> <userId>84331</userId> </userList> </request>'
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.80" statusCode="1"> <Result> <UserGroup> <Id>23680</Id> </UserGroup> </Result> </response>