Note |
---|
Make sure you set the HTTP Content-Type header to be application/json. |
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Making API Requests
|
Request Object Attributes
Attribute | Type | Limits | Possible Names | Description |
---|---|---|---|---|
apiToken | String | 50-character alphanumeric including dashes. | apiToken | (Required)Your supplied API Token. |
Amountplate | String | 950-character decimalalphanumeric. | amountplate 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 | 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:sEnd Date | String | 20-characters Y-m-d\TH:i:s format. | endTime EndDateUtc | (Required)Must be in the format of Y-m-d\TH:i:s
License Plate | String | 25-characters | plate LicencePlate | (Required) The plate of the vehicle. |
Ticket Number | String | 50-characters | permitNo TicketNumber | (Optional) |
Zone Name | String | 200-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 Required)The license plate. |
plateTypeID | String | The ID of the VechiclePlateType record. | plateTypeID | (One of plateTypeID or plateType is required)Your supplied VehiclePlateType identifier. |
plateType | String | 50-character alphanumeric including dashes. | plateType | (One of plateTypeID or plateType is required) The name of the plate type. |
provID | String | The ID of the state/province. | provID | (One of provID or prov is required) Your supplied state or province identifier. |
prov | String | 50-character alphanumeric including dashes | prov | (One of provID or prov is required) The full name of the state/province or the corresponding postal abbreviation. |
makeID | String | The ID of the vehicle make. | makeID | (Optional) Your supplied vehicle make identifier. |
make | String | 50-character alphanumeric including dashes | make | (Optional) The name of the vehicle manufacturer. |
typeID | String | The ID of the vehicle type. | typeID | (Optional) Your supplied vehicle type identifier. |
type | String | 50-character alphanumeric including dashes | type | (Optional) The name of the type of vehicle that you provided. |
colourID | String | The ID of the vehicle colour. | colourID | (Optional) Your supplied vehicle colour identifier. |
colour | String | 50-character alphanumeric including dashes | colour | (Optional) The name of a colour that you have provided.. |
year | String | 4 digit year. | year | (Optional) The model year. |
vin | String | 25-characters | vin | (Optional) The vehicle identification number. |
Successful Response
The response will be a json object.
Content-Type: application/json
Code Block | ||||
---|---|---|---|---|
| ||||
{ "status": "success", "referencevehicle_id_id": "1a9b5375-cb75-4c71-9939-eeae550b09ac158", "InternalReferenceIDwarnings":["The "1a9b5375-cb75-4c71-9939-eeae550b09ac"vehicle colour name was too long and has been truncated."] } |
Related Pages
Filter by label (Content by label) | ||||||||
---|---|---|---|---|---|---|---|---|
|
Show if | ||
---|---|---|
| ||
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. Server setup The Addresses used for testing and production: https://controller.dev-dev14.parkadminoperationscommander.comio/api/OC-_TOMA/v1/permitsvehicles/push https://controller-.preview.operationscommander.comio/api/OC-_TOMA/v1/permitsvehicles/push https://controller.operationscommander.comio/api/OC-_TOMA/v1/permitsvehicles/push nGinx needs to have Access-Control-Allow-Origin : * to work. The controller also needs to be behind a certificate. Client Setup There is some setup related to getting clients to use the API. First, they must have an API token that exists on the API token table. THey They then have to have a an api_permission record that lists what kind of permission the token can hashave. The permission needed for this api request is vehicle-create. |