logo   HOME

Groups

This page lists the optional parameters, request data and reponse in xml

Retrieve all groups [HTTP GET]

https://appapi.dlangemobile.com/xml/groups/{api_key}

URL Parameters

  • api_key (Required) - Your API application key.

Response Notes

  • ID - Used to update, delete and get group contacts
  • ColorCode - color value in 32-bit ARGB format.

Example XML Response

<Groups>
  <GroupContact>
    <ID>2147483647</ID>
    <Name>String content</Name>
    <ColorCode>-13434625</ColorCode>
    <ContactsCount>10</ContactsCount>
  </GroupContact>
  <GroupContact>
    <ID>2147483647</ID>
    <Name>String content</Name>
    <ColorCode>-256</ColorCode>
    <ContactsCount>23</ContactsCount>
  </GroupContact>
</Groups>

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.

Add new group [HTTP POST]

https://appapi.dlangemobile.com/xml/groups/{api_key}

URL Parameters

  • api_key (Required) - Your API application key.

Request Notes

  • ColorCode - color value in 32-bit ARGB format.

Example XML Request

<Group>
  <Name>Group name</Name>
  <ColorCode>-13434625</ColorCode>
</Group>

Response Notes

  • ID - Automatically-assigned ID used to update, delete and get group contacts

Example XML Response

<Group>
  <ID>1</ID>
  <Name>Group name</Name>
  <ColorCode>-13434625</ColorCode>
</Group>

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 208 - Provide a valid group info. Request XML is invalid or not passed as post data.
  • 204 - Provide a group name.
  • 205 - Group name should contain a maximum of 20 characters.
  • 206 - Invalid color code format. It must be a 32-bit ARGB value.
  • 207 - Group name already exists.