The Objects list resource represents a set of objects in a given agency. This can include both active and/or deleted objects.
HTTP GET
GET /api/2013-12-01/Objects/[Agency ID]
Returns a list of objects for the given [Agency ID].
Paging
Paging can be accomplished by passing the page request parameter. By default only 100 objects are returned per request. You can use the page_size request parameter to specify up to 10,000 objects per request.
List Filters
The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.
| Parameter | Description |
|---|---|
| Object_ID | Only show objects who’s Object ID matches the provided information. |
| Tab_ID | Only show objects on a given Tab, by ID. |
| Contact_ID | Only show objects who have the given Contact ID assigned as the current Occupant |
| Status | Only show objects in the given Status,valid values include [Active, Deleted] |
| Color | Only show objects with the given border Color. Valid values include [Black, Blue, Green, Red, White, Yellow] |
| Indicator | Only show objects with the given Indicator color. Valid values include [Black, Blue, Green, Red, White, Yellow] |
| Name | Only show objects that contain the given Name. |
| Organization | Only show objects that contain the given Organization. |
| Subtitle | Only show objects that contain the given Subtitle. |
| Tags | Only show objects that contain the given Tags. |
| Type | Only show objects of the given Type. Valid values include [Role, Group, Radio, Camera] |
| Weblink | Only show objects that contain the given Weblink. |
Example Request
Fetch the entire list.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Objects/[Agency ID] \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2015-09-21T15:39:22+00:00",
"objects": [
{
"Object ID": 497,
"Tab ID": 1,
"Contact ID": null,
"Created": 1351641718,
"Status": "Active",
"Type": "Role",
"Name": "Orlando Police Dept",
"Subtitle": "",
"Tags": "Hazmat, K9 Team",
"Color": "Black",
"Indicator": "Green",
"Weblink": "http://www.google.com"
}
], ...],
"results": 235,
"pages": 3,
"page": 0,
"page_tart": 0,
"page_end": 99,
"page_size": 100
}
Example Request
Show only those objects who’s Tags field contains the tag “Hazmat”.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Objects/[Agency ID] \
-d "Tags=Hazmat" \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2015-09-21T15:28:26+00:00",
"objects": [
{
"Object ID": 497,
"Tab ID": 1,
"Contact ID": null,
"Created": 1351641718,
"Status": "Active",
"Type": "Role",
"Name": "Orlando Police Dept",
"Subtitle": "",
"Tags": "Hazmat, K9 Team",
"Color": "Black",
"Indicator": "Green",
"Weblink": "http://www.google.com"
}
],
"results": 1,
"pages": 1,
"page": 0,
"page_start": 0,
"page_end": 0,
"page_size": 100
}