Versions Compared

Key

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


Info
iconfalse

This page details deleting a permit using the OPS-COM API.

Table of Contents

Twitterconnector
componentTypebuttonTweet
embedTypetweetButton
linkTweet
width460
lang
height500
tweetLimit20


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

Making API Requests

Note

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


Section
bordertrue


Column
width50%

Raw Request

Code Block
languagetext
themeMidnight
POST /api/OC-TOMA/v1/permits/delete HTTP/1.1
Host: controller.parkadmin.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
themeMidnight
var request = new XMLHttpRequest();

request.open('POST', 'https://controller.parkadmin.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
themeMidnight
{
    "status": "success",
    "reference_id": "1a9b5375-cb75-4c71-9939-eeae550b09ac",
    "InternalReferenceID": "1a9b5375-cb75-4c71-9939-eeae550b09ac"
}