Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

For internal documentation see this: https://wiki.ops-com.com/x/c4UCAw

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

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

Raw Request

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

{
	"apiToken": "YOUR-API-TOKEN",
	"Amount": "14.50",
	"CurrencyID": "CAD",
	"LicencePlate": "PL8RDR",
	"zone": "Lot 4",
	"zoneID": "4",
	"permitNo": "L4-1138",
	"startTime": "2018-07-02T09:00:00",
	"endTime": "2018-07-02T09:30:00"
}

JavaScript Request

JavaScript
var request = new XMLHttpRequest();

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

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",
	"Amount": "14.50",
	"CurrencyID": "CAD",
	"LicencePlate": "PL8RDR",
	"zone": "Lot 4",
	"zoneID": "4",
	"permitNo": "L4-1138",
	"startTime": "2018-07-02T09:00:00",
	"endTime": "2018-07-02T09:30:00"
}
request.send(JSON.stringify(body));

Request object attributes:

AttributeTypeLimitsPossible NamesDescription
apiTokenString

50-character alphanumeric including dashes

apiToken(Required) Your supplied API Token.
AmountString9-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.

CurrencyString10-characters

currency

CurrencyID

(Optional) CAD, USD

Start Date

String

20-characters

Y-m-d\TH:i:s format.

startTime

StartDateUtc

(Required) 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

End DateString

20-characters

Y-m-d\TH:i:s format.

endTime

EndDateUtc

(Required) 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 PlateString25-characters

plate

LicencePlate

(Required) The plate of the vehicle.
Ticket NumberString50-characters

permitNo

TicketNumber

(Optional)
Zone NameString200-characters

zone

ParkingZoneName

(Optional) If the zone does not match a zone in our system, it will be a disconnected record and may not report properly.



Successful Response:

The response will be a json object. 

Content-Type: application/json

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



Errors:

Content-Type: application/json

Errors
{
    "ErrorCode": 9001,
    "ErrorMessage": "API Token is missing from the request."
}

List of errors:

Error CodeError Message
9000Client Code is missing from the request.
9001API Token is missing from the request.
9002The supplied API token does not have permission to perform that request.
9003Could not parse the request.
9004End Time is a required field.
9005The end time value is invalid.
9006Plate is a required field.
9007The start time value is invalid.
OperationsCommander parking and security management platform
  • No labels