> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/listing.md).

# Vehicle status listing

Deprecated. The list of statuses a vehicle could be set to.

{% hint style="warning" %}
**Deprecated.** These actions should not be used.
{% endhint %}

A vehicle status listing was the set of statuses a vehicle could be set to, in the way a [working status list](/docs/navixy-api/user-api/resources/tracking/status/listing.md) works for a tracker. The operations still answer, and are documented because they are still reachable, but nothing new should be built on them.

## Vehicle status listing object

## The VehicleStatusListing object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"VehicleStatusListing":{"type":"object","description":"One entry in the vehicle status list.","properties":{"id":{"type":"integer","description":"ID of the status."},"order":{"type":"integer","description":"Position of the status. **Ignored on update**, where position comes from the array order."},"label":{"type":"string","description":"Status name or description."},"color":{"type":"string","description":"RGB colour."}}}}}}
```

## API actions

API base path: `/vehicle/status/listing`.

Operations that list no errors of their own return only the [general error codes](/docs/navixy-api/general/errors.md#error-codes).

Reads the vehicle status list of the current user.

***

## Read vehicle status listing

> Return the vehicle status list of the current user. Callable with an empty body. Also accepts GET.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Vehicles","description":"Vehicles in the fleet, their avatars and status list, spreadsheet import, and the service works scheduled against them. All resources under the /vehicle/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VehicleStatusListing":{"type":"object","description":"One entry in the vehicle status list.","properties":{"id":{"type":"integer","description":"ID of the status."},"order":{"type":"integer","description":"Position of the status. **Ignored on update**, where position comes from the array order."},"label":{"type":"string","description":"Status name or description."},"color":{"type":"string","description":"RGB colour."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/vehicle/status/listing/read":{"post":{"tags":["Vehicles"],"summary":"Read vehicle status listing","description":"Return the vehicle status list of the current user. Callable with an empty body. Also accepts GET.","operationId":"vehicleStatusListingRead","responses":{"200":{"description":"The status listing","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/VehicleStatusListing"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

***

Replaces the vehicle status list. `order` is ignored on update, because statuses already have a position in the array.

*Required sub-user rights:* `vehicle_update`.

## Update vehicle status listing

> Replace the vehicle status list.\
> \
> \`order\` is ignored on update, because position is taken from the array order.\
> \
> Requires the \`vehicle\_update\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Vehicles","description":"Vehicles in the fleet, their avatars and status list, spreadsheet import, and the service works scheduled against them. All resources under the /vehicle/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"VehicleStatusListing":{"type":"object","description":"One entry in the vehicle status list.","properties":{"id":{"type":"integer","description":"ID of the status."},"order":{"type":"integer","description":"Position of the status. **Ignored on update**, where position comes from the array order."},"label":{"type":"string","description":"Status name or description."},"color":{"type":"string","description":"RGB colour."}}}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/vehicle/status/listing/update":{"post":{"tags":["Vehicles"],"summary":"Update vehicle status listing","description":"Replace the vehicle status list.\n\n`order` is ignored on update, because position is taken from the array order.\n\nRequires the `vehicle_update` right.","operationId":"vehicleStatusListingUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"statuses":{"type":"array","description":"The status list, in the order they should appear.","items":{"$ref":"#/components/schemas/VehicleStatusListing"}}},"required":["statuses"]}}}},"responses":{"200":{"description":"Status listing updated","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/fleet/vehicle/listing.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.