Lot Value API
The Lot Value API provides administrators with a programmatic version of the existing Lot Value Report. Its primary purpose is to retrieve real-time parking lot occupancy, valuation, and capacity data directly from the OPSCOM Controller, allowing organizations to independently ingest this information into their own custom data dashboards or third-party reporting tools.
Setup and Configuration
Before querying the endpoint, A Tomahawk Support agent must generate an authentication token with the correct structural permissions assigned. Once this token is generated for you, it will be sent securely to you, and you can use this API key in the body of a get request, sent to this endpoint:
| https://controller.preview.operationscommander.io/api/[YOUR CLIENT ID]/v1/permits/lot-values |
This is how the body should be formatted to receive lot values in return;
|
{
"apiToken": "0d2bef1a-4819-4c6a-b552-1b9e3d936333"
}
|
Using this Feature
The endpoint mimics the data structure of the standard system report but delivers it as a structured payload for external integration.
Expected API Responses
A successful request returns a structured JSON payload containing real-time data for all configured parking lots. The output includes individual lot identifiers, total capacities, active permit counts, current vehicle volume calculations, and the monetary value assigned to the spaces.
If an unauthenticated or incorrectly configured key is passed into the request body, the server rejects the connection.
IfHere is an incorrectexample tokenof is provided, or if the token used lacks the explicit lot values permission checkbox validation,what the API returnswill areturn:
| [ "lot_name": "TU Residence", "default_cost": 525, "total_permits": 20, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "TU Residence Visitors", "default_cost": 11, "total_permits": 0, "rented_permits": 0, "utilized_pct": null, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "S", "lot_name": "TU Semester East", "default_cost": 100, "total_permits": 21, "rented_permits": 17, "utilized_pct": 80.95, "amount_projected": 1700, "amount": 2897.8783, "tax_amount": 0, "tax_amount1": 144.89392, "tax_amount2": 231.83026, "total": 3274.6 }, { "lot_type": "M", "lot_name": "TU Semester Central", "default_cost": 125, "total_permits": 60, "rented_permits": 3, "utilized_pct": 5, "amount_projected": 375, "amount": 313.08447, "tax_amount": 0, "tax_amount1": 15.65422, "tax_amount2": 25.04676, "total": 353.79 }, { "lot_type": "Y", "lot_name": "TUSC Yearly Staff", "default_cost": 350, "total_permits": 10, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "Y", "lot_name": "TUSC Yearly Executive", "default_cost": 0, "total_permits": 10, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "TU Visitors", "default_cost": 11, "total_permits": 0, "rented_permits": 0, "utilized_pct": null, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "Veritas Communications - All Lots", "default_cost": 165, "total_permits": 28, "rented_permits": 2, "utilized_pct": 7.14, "amount_projected": 330, "amount": 330, "tax_amount": 0, "tax_amount1": 16.5, "tax_amount2": 26.4, "total": 372.9 }, { "lot_type": "M", "lot_name": "Veritas Communications - Complimentary", "default_cost": 0, "total_permits": 5, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "North Lot", "default_cost": 195, "total_permits": 0, "rented_permits": 0, "utilized_pct": null, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "Solus Tech Inc", "default_cost": 183, "total_permits": 15, "rented_permits": 2, "utilized_pct": 13.33, "amount_projected": 366, "amount": 366, "tax_amount": 0, "tax_amount1": 18.3, "tax_amount2": 29.28, "total": 413.58 }, { "lot_type": "M", "lot_name": "Recreation Complex", "default_cost": 0, "total_permits": 0, "rented_permits": 0, "utilized_pct": null, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "Main Street Parking", "default_cost": 200, "total_permits": 20, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "O", "lot_name": "Public Works", "default_cost": 0, "total_permits": 30, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "Mall Parking", "default_cost": 0, "total_permits": 0, "rented_permits": 0, "utilized_pct": null, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "Main Street Private Parking", "default_cost": 150, "total_permits": 200, "rented_permits": 0, "utilized_pct": 0, "amount_projected": 0, "amount": 0, "tax_amount": 0, "tax_amount1": 0, "tax_amount2": 0, "total": 0 }, { "lot_type": "M", "lot_name": "TU South Garage", "default_cost": 75, "total_permits": 3000, "rented_permits": 2, "utilized_pct": 0.07, "amount_projected": 150, "amount": 150, "tax_amount": 0, "tax_amount1": 7.5, "tax_amount2": 12, "total": 169.5 } ] |
Best Practices and Considerations
-
Verify token scopes before deployment. The API token must be exactly as it appears when it was sent to you by OPSCOM. It is your information's password.
-
Match pull frequencies to operational needs. This API should not need to be polled more than once an hour.