WikiSysop: Created page with '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 …'

WikiSysop — Tue, 03 Aug 2010 04:59:26 GMT

Created page with '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 …'

New page

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:''''' <nowiki>http://api.rezora.com/v1/groups/123/agents/12345</nowiki>

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 ====
<source lang="xml">
<?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>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"usertogroup_id":"123456",
"user_id":"12345",
"group_id":"123",
"usertogroup_timestamp":"2010-07-21 16:46:01"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"usertogroup_id"|"user_id"|"group_id"|"usertogroup_timestamp"
"123456"|"12345"|"123"|"2010-07-21 16:46:01"
</source>
</div>

== 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 ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<status>200</status>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"status":"200"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"status"
"200"
</source>
</div>
[[Category:Resource Definitions]]
[[Category:Company Resources]]

Resource Definitions:Groups/ID/Agents/ID - Revision history

WikiSysop: Created page with '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 …'