Resource Definitions:Groups/ID/Agents/ID

From API Documentation

Latest revision as of 04:59, 3 August 2010

The groups/ID/agents/ID resource is an individual agent-to-group association between the designated group and agent, where the first "ID" is the groups's group_id number and the second "ID" is the agent's agent_id number.

Example URI: http://api.rezora.com/v1/groups/123/agents/12345

Available methods are:

GET

Returns an individual agent-to-group association between the designated group and agent. The association record includes the following fields:

• usertogroup_id
• user_id
• group_id
• usertogroup_timestamp

Example Responses

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
 <group_agent>
  <usertogroup_id>123456</usertogroup_id>
  <user_id>12345</user_id>
  <group_id>123</group_id>
  <usertogroup_timestamp>2010-07-21 16:46:01</usertogroup_timestamp>
 </group_agent>
</group_agents>

JSON Response

[
 {
  "usertogroup_id":"123456",
  "user_id":"12345",
  "group_id":"123",
  "usertogroup_timestamp":"2010-07-21 16:46:01"
 }
]

CSV Response

"usertogroup_id"|"user_id"|"group_id"|"usertogroup_timestamp"
"123456"|"12345"|"123"|"2010-07-21 16:46:01"

DELETE

Permanently removes an individual agent-to-group association between the designated group and agent, and returns a success code.

Example Response Data

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
 <group_agent>
  <status>200</status>
 </group_agent>
</group_agents>

JSON Response

[
 {
  "status":"200"
 }
]

CSV Response

"status"
"200"