Note |
---|
Make sure you set the HTTP Content-Type header to be application/json. |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Making API Requests
|
Request Object Attributes
Attribute | Type | Limits | Possible Names | Description |
---|---|---|---|---|
apiToken | String | 50-character alphanumeric including dashes. | apiToken | (Required)Your supplied API Token. |
client | String | client identifier | Required | |
plate | String | vehicle plate | Required |
Successful Response
The response will be a json object.
Content-Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
/*
The below response is a merged example of different fields that may be in the response.
- type response may be "standard" or "temp"
An empty response (no permits, alarms or DNTT) will result in an empty JSON bundle:
{
"response": "",
"plate": "ABC123",
"responseJSON": {}
}
*/
{
"response": "standard: Faculty/Staff Permit\n Expires: 2099-06-01 23:59:59\n\nDNTT: Main Campus\n2024-11-15 00:00:00-2024-11-15 23:59:00 \nCLEAR FOR ANY PAY AREA\n\nALARM: Wanted to talk with.\n\n",
"plate": "ABC123",
"responseJSON": {
"expires": "2099-06-01 23:59:59",
"active": "1",
"type": "standard",
"shortName": "Faculty/Staff Permit"
"dntt": [{
"notes": "CLEAR FOR ANY PAY AREA",
"start": "2024-11-15 00:00:00",
"location": "Main Campus",
"end": "2024-11-15 23:59:00"
}],
"alarm":"Wanted to talk with."
}
} |
Related Pages
Filter by label (Content by label) | ||||||||
---|---|---|---|---|---|---|---|---|
|
Show if | ||
---|---|---|
| ||
In order for a client to use this, they would have to have paid for the right to integrate with OPS-COM, been issued an API Key and had their integration validated by testing with us. Client Setup There is some setup related to getting clients to use the API. First, they must have an API token that exists on the API token table. The permission needed for this api request is |