Skip to main content
Omnitracs Knowledge Base

Create Group

createGroup

Creates a group entry on the MMS grouping server given a group name and description.
 

createGroupResponse createGroup(CreateGroupRequest request)

Elements in the CreateGroupRequest:

  • groupName: A string containing the name of the group being created.
  • groupDescription: An optional description of the group.

     

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<SOAP-ENV:Body>
  <createGroupRequest xmlns="http://www.qualcomm.com/qgs">
    <groupName>A New Group</groupName>
    <groupDescription>A Description</groupName>
  </createGroupRequest>
</SOAP-ENV:Body>


Sample XML Response

An empty response conveys success. If there was an error, an exception would have been thrown.

<soapenv:Body>
    <ns2:createGroupResponse xmlns:ns2="http://www.qualcomm.com/qgs"/>
</soapenv:Body>

 

Sample Application Exception

<SOAP-ENV:Body>
  <SOAP-ENV:Fault>
    <faultcode>SOAP-ENV:Client</faultcode>
    <faultstring xml:lang="en">008: Group already exists.</faultstring>
  </SOAP-ENV:Fault>
</SOAP-ENV:Body>


Exceptions

002: Required field not specified. Only the name is required for createGroup
005: Internal error: Call to the Create Group API failed.
006: Group name exceeds limit of 80 characters.
007: Group Description exceeds limit of 255 characters.
008: Group already exists.

 

 

  • Was this article helpful?