Pull API: Plate Validation

Owned by Robin Mulloy
Last updated: Nov 21, 2024
2 min read

Use this API to obtain details related to a plate.  Plate details include permits, alerts and DNTT status.



Make sure you set the HTTP Content-Type header to be application/json.


Making API Requests

Raw Request

POST /api/v1/validate/plate HTTP/1.1
Host: service.ops-com.com
Accept: application/json
Content-Type: application/json
Cache-Control: no-cache

{
	"apiToken": "YOUR-API-TOKEN",
	"client": "<client ID>",
	"plate": "<plate to validate>"
}

JavaScript Request

var request = new XMLHttpRequest();

request.open('POST', 'https://service.ops-com.com/api/v1/validate/plate');

request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};


var body = {
	"apiToken": "YOUR-API-TOKEN",
	"client": "<client ID>",
	"plate": "<plate to validate>"
}
request.send(JSON.stringify(body));

Request Object Attributes

AttributeTypeLimitsPossible NamesDescription
apiTokenString

50-character alphanumeric including dashes.

apiToken(Required) Your supplied API Token.
clientStringclient identifier
Required
plateStringvehicle plate
Required


Successful Response

The response will be a json object. 

Content-Type: application/json

/*
    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