WikiSysop: Created page with 'The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number. '''''Example URI:'''''…'

WikiSysop — Tue, 03 Aug 2010 04:54:06 GMT

Created page with 'The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number. '''''Example URI:'''''…'

New page

The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number.

'''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups/123/agents</nowiki>

Available methods are:

== GET ==
Returns a list of agent-to-group associations for the designated group. Each 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>1234567</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>

== POST ==
Adds a new agent-to-group association for the designated group, and returns the new association ID. You may include the following fields (required fields marked with a red asterisk ('''<span style="color: #f00;">*</span>''')):

* user_id '''<span style="color: #f00;">*</span>''' - ''must be unique within this group''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<user_id>12346</user_id>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"user_id":"12346"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
user_id=12346
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<group_agents version="1.0">
<group_agent>
<usertogroup_id>123457</usertogroup_id>
</group_agent>
</group_agents>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"usertogroup_id":"123457"
}
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"usertogroup_id"
"123457"
</source>
</div>

== DELETE ==
Permanently removes ALL agent-to-group associations for the designated group, 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 - Revision history

WikiSysop: Created page with 'The ''groups/ID/agents'' resource is a collection of all agent-to-group associations for the designated group, where "ID" is the group's group_id number. '''''Example URI:'''''…'