Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Info
iconfalse

The OPS-COM Controller provides a simple JSON based API to integrate with. Clients use this API to directly feed details about existing paid permits and their changes into OPS-COM from other systems such as Parking apps.  

Table of Contents

Twitterconnector
componentTypebuttonTweet
embedTypetweetButton
linkTweet
width460
lang
height500
tweetLimit20



Note

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


Section
bordertrue

Making API Requests

Column
width50%

Raw Request

Code Block
languagetext
theme

...

Midnight
POST /api/OC-TOMA/v1/permits/delete 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"
}



Column
width50%

JavaScript Request

Code Block
languagejs
theme

...

Midnight

...

var request = new XMLHttpRequest();

request.open('POST', 'https://controller.

...

operationscommander.com/api/OC-TOMA/v1/permits/delete');

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"
}
request.send(JSON.stringify(body));



Request

...

Object Attributes

AttributeTypeLimitsPossible NamesDescription
apiTokenString

50-character alphanumeric including dashes

apiToken(Required)Your supplied API Token.

Reference ID

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



Successful Response

...

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

Content-Type: application/json

Code Block
languagejs
theme

...

Midnight

...

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

...


Related Pages

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
cqllabel in ("api","apis") and space = currentSpace()


Show If
special@authenticated


Warning
titleSupport Agent Notes

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.

The permission needed for this api request is permit-create. They can only delete records which they have created.