WikiSysop: Created page with 'The ''groups'' resource is a collection of all groups associated with your company account. '''''Example URI:''''' http://api.rezora.com/v1/groups Available m…'

2010-08-03T04:33:40Z

Created page with 'The ''groups'' resource is a collection of all groups associated with your company account. '''''Example URI:''''' <nowiki>http://api.rezora.com/v1/groups</nowiki> Available m…'

New page

The ''groups'' resource is a collection of all groups associated with your company account.

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

Available methods are:

== GET ==
Returns a list of groups. Each group record includes the following fields:

* group_id
* group_name
* group_timestamp

=== Example Responses ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<group_id>123</group_id>
<group_name>East Branch Office</group_name>
<group_timestamp>2010-07-21 16:28:52</group_timestamp>
</group>
...
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"group_id":"123",
"group_name":"East Branch Office",
"group_timestamp":"2010-07-21 16:28:52"
}
...
]
</source>

==== CSV Response ====
<div style="overflow: auto;">
<source lang="text">
"group_id"|"group_name"|"group_timestamp"
"123"|"East Branch Office"|"2010-07-21 16:28:52"
...
</source>
</div>

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

* group_name '''<span style="color: #f00;">*</span>''' - ''must be unique''

=== Example Request Data ===

==== XML Request ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<data>
<group_name>West Branch Office</group_name>
</data>
</source>

==== JSON Request ====
<source lang="javascript">
{
"data":{
"group_name":"West Branch Office"
}
}
</source>

==== TEXT Request ====
<div style="overflow: auto;">
<source lang="text">
group_name=West+Branch+Office
</source>
</div>

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<group_id>124</group_id>
</group>
</groups>
</source>

==== JSON Response ====
<source lang="javascript">
[
{
"group_id":"124"
}
]
</source>

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

== DELETE ==
Permanently removes ALL groups and returns a success code.

=== Example Response Data ===

==== XML Response ====
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
<group>
<status>200</status>
</group>
</groups>
</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 - Revision history

WikiSysop: Created page with 'The ''groups'' resource is a collection of all groups associated with your company account. '''''Example URI:''''' http://api.rezora.com/v1/groups Available m…'