Update one of a worker's Driver CPC entitlements

PUT

/v1/workers/{workerId}/cpc-licence-categories/{id}

curl --request PUT \
  --url https://api2.recruso.co.uk/v1/workers/1/cpc-licence-categories/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "workerId": 4821, "id": 3310, "vehicleCategoryId": 2, "validFrom": "2021-09-10", "validUntil": "2026-09-09" }'

• Production

Replaces a Driver CPC entitlement recorded for a worker in your own agency — its vehicle class, or the period it runs.

Use it to fix a record entered wrongly. A renewed entitlement is a new record with its own period: overwriting the old one would erase what the worker was entitled to before.

All three fields are required. A record that belongs to a different worker, or to another agency, returns 404 rather than 403. modifiedBy and modifiedOn are set from your credentials and the current UK local time.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

• Bearer

Parameters

Path Parameters

workerId

required

integer format: int32

The workerId path parameter

id

required

integer format: int32

The id path parameter

Request Body^required

Media typeapplication/json

The replacement values for a Driver CPC entitlement already recorded. Every field is written from the request, and all three are required.

object

workerId

The worker the entitlement belongs to. Taken from the route; a value in the request body is ignored.

integer format: int32

Example

4821

id

The entitlement to update. Taken from the route; a value in the request body is ignored.

integer format: int64

Example

3310

vehicleCategoryId

The vehicle class, as an id from the platform Vehicle categories vocabulary. Required.

integer format: int16

Example

2

validFrom

The date the entitlement starts. Required.

string format: date

Example

2021-09-10

validUntil

The date the entitlement runs to. Required, and must not be before the start date — both columns are NOT NULL, so a CPC entitlement always has an end.

string format: date

Example

2026-09-09

Responses

200

OK

Media typeapplication/json

object

driverCpcLicenceCategoryId

The record’s identifier.

integer format: int64

vehicleCategoryId

The vehicle class, as an id from the platform Vehicle categories vocabulary.

integer format: int16

validFrom

The date the entitlement starts.

string format: date

validUntil

The date the entitlement runs to.

string format: date

Example

{
  "driverCpcLicenceCategoryId": 3310,
  "vehicleCategoryId": 2,
  "validFrom": "2021-09-10",
  "validUntil": "2026-09-09"
}

400

Bad Request

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"
}

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"
}

403

Forbidden

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"
}