Skip to main content

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​

Successful operation