Contacts

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

Assign group to contact [HTTP PUT]

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

URL Parameters

• api_key (Required) - Your API application key.
• contact_id (Required) - ID of contact.
• group_id (Required) - Group ID to assign to contact.

Response Notes

Returns a list of all groups assigned to the contact including the group ID if successful. ColorCode is in 32-bit ARGB format.

Example XML Response

<Groups>
  <Group>
    <ID>1</ID>
    <Name>Group 1</Name>
    <ColorCode>-256</ColorCode>
  </Group>
  <Group>
    <ID>2</ID>
    <Name>Group 2</Name>
    <ColorCode>-13434625</ColorCode>
  </Group>
</Groups>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 101 - Define a valid Contact ID.
• 102 - Invalid Contact ID format. Contact ID should be an integer.
• 103 - Contact not found. Please provide a valid Contact ID.
• 201 - Define a valid Group ID.
• 202 - Invalid Group ID format. Group ID should be an integer.
• 203 - Group not found. Please provide a valid Group ID.

Remove contact from group [HTTP DELETE]

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

URL Parameters

• api_key (Required) - Your API application key.
• contact_id (Required) - ID of contact to remove from group.
• group_id (Required) - Group ID.

Response Notes

Returns a list of all groups assigned to the contact including the group ID if successful. ColorCode is in 32-bit ARGB format.

Example XML Response

<Groups>
  <Group>
    <ID>1</ID>
    <Name>Group 1</Name>
    <ColorCode>-256</ColorCode>
  </Group>
  <Group>
    <ID>2</ID>
    <Name>Group 2</Name>
    <ColorCode>-13434625</ColorCode>
  </Group>
</Groups>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 101 - Define a valid Contact ID.
• 102 - Invalid Contact ID format. Contact ID should be an integer.
• 103 - Contact not found. Please provide a valid Contact ID.
• 201 - Define a valid Group ID.
• 202 - Invalid Group ID format. Group ID should be an integer.
• 203 - Group not found. Please provide a valid Group ID.