Permit Update API

The OPS-COM Controller provides a simple JSON based API to integrate with.

Making API Requests

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

Raw Request

POST /api/OC-TOMA/v1/permits/update HTTP/1.1
Host: controller.operationscommander.com
Accept: application/json
Content-Type: application/json
Cache-Control: no-cache

{
	"apiToken": "YOUR-API-TOKEN",
	"referenceID": "PREVIOUS-REFERENCE-ID",
	"plate": "PL8RDR",
	"Amount": "14.50",
	"currency": "CAD",
	"endTime": "2018-07-02T09:30:00"
}

JavaScript Request

var request = new XMLHttpRequest();

request.open('POST', 'https://controller.operationscommander.com/api/OC-TOMA/v1/permits/update');

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",
	"referenceID": "PREVIOUS-REFERENCE-ID",
	"plate": "PL8RDR",
	"Amount": "14.50",
	"currency": "CAD",
	"endTime": "2018-07-02T09:30:00"
}
request.send(JSON.stringify(body));

Request object attributes

Attribute	Type	Limits	Possible Names	Description
apiToken	String	50-character alphanumeric including dashes	apiToken	(Required) Your supplied API Token.
Reference ID	String	50-character alphanumeric including dashes	referenceid referenceID reference_id	(Required) This value is supplied to when the permit push api is successful. e.g. 1a9b5375-cb75-4c71-9939-eeae550b09ac
End Date	String	20-characters Y-m-d\TH:i:s format.	endTime EndDateUtc	(Optional) Must be in the format of Y-m-d\TH:i:s e.g. 2000-05-30T14:38:22 For formatting help, see PHP Date Formatting
License Plate	String	25-characters	plate LicencePlate	(Optional) The plate of the vehicle.
Amount	String	9-character decimal	amount Amount	(Optional) Transaction amount This must contain at least 3 digits, two of which are penny values. The minimum allowable value is $0.01, and the maximum allowable value is $999999.99.
Currency	String	10-characters	currency CurrencyID	(Optional) CAD, USD

Successful Response

The response will be a json object. The same reference id will be returned.

Content-Type: application/json

{
    "status": "success",
    "reference_id": "1a9b5375-cb75-4c71-9939-eeae550b09ac",
    "InternalReferenceID": "1a9b5375-cb75-4c71-9939-eeae550b09ac"
}