Get start inhibit status for all vehicles
GET/vehicles/start-inhibit/status
Returns the start inhibit status of every vehicle the caller may address. start_inhibit: true means the vehicle is currently immobilised, the same meaning the field carries on PUT /vehicles/{registration}/start-inhibit.
This function requires a specific fitment by Cartrack. A vehicle appears here only when it has an active contract and a terminal fitted, so a vehicle absent from this listing cannot be immobilised either. A sub-user sees only the vehicles granted to it, and the pagination metadata describes that same set. A vehicle that carries no registration is left out, because there is no value to address it by on PUT /vehicles/{registration}/start-inhibit, so it is not counted in meta.total either. A vehicle whose state cannot be read is still listed and still counted, carrying start_inhibit: null, so the rows returned always match meta.total. The state cannot be read when the vehicle has no active contract and terminal, when it is under an open emergency control room case, or when its terminal has never reported an immobiliser state. Use filter[registration] to look up a single vehicle, which responds with 404 when the registration is not one the caller may address.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
- 503
Successful operation
Unauthorized access. Authentication is required.
Access is forbidden. The user does not have permission to access this resource, or the account is not currently active.
The requested resource was not found.
Validation failed for the input parameters.
Too Many Requests - the endpoint's rate limit has been exceeded. Retry after the number of seconds in the Retry-After header.
Response Headers
Seconds to wait before retrying. The same value as X-RateLimit-Retry-After-Seconds when that wait is non-negative. If the computed wait is negative, Retry-After is floored at 0.
Unix timestamp of the next earliest successful request.
Seconds until the next earliest successful request.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.