Resource Definitions:Groups/ID

From API Documentation

Latest revision as of 04:43, 3 August 2010

The groups/ID resource is an individual group associated with your company account, where "ID" is the group's group_id number.

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

Available methods are:

GET

Returns an individual group. The group record includes the following fields:

• group_id
• group_name
• group_timestamp

Example Responses

XML Response

<?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>

JSON Response

[
 {
  "group_id":"123",
  "group_name":"East Branch Office",
  "group_timestamp":"2010-07-21 16:28:52",
 }
]

CSV Response

"group_id"|"group_name"|"group_timestamp"
"123"|"East Branch Office"|"2010-07-21 16:28:52"

PUT

Updates an existing group, and returns a success code. You may include the following fields (required fields marked with a red asterisk (*)):

• group_name * (must be unique)

Example Request Data

XML Request

<?xml version="1.0" encoding="UTF-8"?>
<data>
 <group_name>Eastern Branch Office</group_name>
</data>

JSON Request

{
 "data":{
  "group_name":"Eastern Branch Office"
 }
}

TEXT Request

group_name=Eastern+Branch+Office

Example Response Data

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
 <group>
  <status>200</status>
 </group>
</groups>

JSON Response

[
 {
  "status":"200"
 }
]

CSV Response

"status"
"200"

DELETE

Permanently removes an individual group, and returns a success code.

Example Response Data

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<groups version="1.0">
 <group>
  <status>200</status>
 </group>
</groups>

JSON Response

[
 {
  "status":"200"
 }
]

CSV Response

"status"
"200"