Get vehicle category details

GET

/v1/reference/vehicle-categories/{id}

curl --request GET \
  --url https://api2.recruso.co.uk/v1/reference/vehicle-categories/1 \
  --header 'Authorization: <Authorization>'

• Production

Returns one vehicle category by id. The DVLA licence categories a driver can hold.

Vehicle categories are platform-wide, so an id means the same vehicle category for every agency.

An id that does not match a vehicle category returns 404.

Access. Requires an authenticated token. No further policy is applied.

Authorizations

• Bearer

Parameters

Path Parameters

id

required

integer format: int32

The id path parameter

Responses

200

OK

Media typeapplication/json

One vehicle category.

object

id

The vehicle category’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16

name

The vehicle category name, as it appears in Recruso. Up to 10 characters. Unique across all vehicle categories.

string

description

A longer description of the vehicle category. May be null.

string

nullable

Example

{
  "id": 1,
  "name": "A",
  "description": "Motorcycle"
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}