SmartGare
API referenceEndpoints

Search vehicle categories

Returns vehicle categories matching optional text and status filters.

GET/referential/v1/vehicle-categories

Returns vehicle categories matching optional text and status filters.

Authorization

oauth2
AuthorizationBearer <token>

In: header

Query Parameters

search?string

Matches part of a code or name.

Defaultnull
status?string

Restrict to one lifecycle status; defaults to ACTIVE.

Defaultnull

Value in

  • "ACTIVE"
  • "RETIRED"
  • "ACTIVE"
  • "RETIRED"
sort?string

Result ordering.

Defaultnull

Value in

  • "codeAsc"
  • "codeDesc"
  • "nameAsc"
  • "nameDesc"
page?integer

Zero-based page index.

Formatint32
Range0 <= value
Defaultnull
size?integer

Page size, at most 200.

Formatint32
Range0 <= value <= 200
Defaultnull

Response Body

*/*

curl -X GET "https://example.com/referential/v1/vehicle-categories"
{  "data": [    {      "code": "string",      "name": "string",      "description": "string",      "status": "string"    }  ],  "page": 0,  "size": 0,  "total": 0}

Resolve an identifier

Resolves a reading to the vehicle carrying it, through the stored normalised form; a reading matching nothing active is not-found and kept as evidence.

Add a vehicle category

Adds a vehicle category to the catalog.