Skip to main content

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, administratorsA Tomahawk Support agent must generate an authentication token with the correct structural permissions assigned.

AdminOnce Sidethis Configuration

token
    is
  1. generated

    Hoverfor overyou, Systemit Administration,will clickbe Security,sent securely to you, and selectyou can use this API Tokens.

    key

  2. Clickin the body of a get request, sent to this endpoint:

    buttonorselect
    https://controller.preview.operationscommander.io/api/Create[YOUR TokenCLIENT ID]/v1/permits/lot-values
    an

    This existingis token fromhow the listbody should be formatted to editreceive itslot properties.values in return;

  3. Enable

    {
        "apiToken": "0d2bef1a-4819-4c6a-b552-1b9e3d936333"
    }

    No other information is required in the lotbody, valuesthis checkboxget withinrequest will return a list of the permissionsvalues matrixof toeach authorize data access for this key.

  4. Click the Save button to commit the security changes.

  5. Copy the generated alphanumeric token string to your clipboard for uselot in yourorder APIof client.

    lot
    6. ID.

Using this Feature

The endpoint mimics the data structure of the standard system report but delivers it as a structured payload for external integration.

Accessing the API

  1. Open Postman and navigate to your workspace.

  2. Open the Shared folder, expand the Controller APIs collection, and select the pre-saved Lot Value API call.

  3. Select the Body tab within the Postman request panel.

  4. Input your copied system token into the designated apiToken field within the request body object.

  5. Click the Send button to dispatch the request to the Controller.

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.

If an incorrect token is provided, or if the token used lacks the explicit lot values permission checkbox validation, the API returns a standard authentication error message and blocks data retrieval.

Best Practices and Considerations

  • Verify token scopes before deployment. IfThe API token must be exactly as it appears when it was sent to you by OPSCOM. It is your dashboardinformation's integration suddenly reports authorization failures, navigate back to the API Tokens page to verify that the lot values checkbox has not been accidentally disabled.password.

  • Match pull frequencies to operational needs. Because thisThis API calculatesshould real-timenot lot values and occupancy data directly from active database rows, avoid aggressive polling intervals (such as multiple requests per second)need to preventbe unnecessarypolled processingmore loadthan ononce youran tracking Controller.

  • Align API outputs with internal dashboard names. Ensure your custom reporting tools map directly to the system lot string identifiers returned in the payload. If you modify a lot name on the Lot Administration page, the API will instantly reflect that change in its next data transmission.hour.

Back to top