Skip to content

Add a Driver CPC training period to a worker

POST
/v1/workers/{workerId}/cpc-training
curl --request POST \
--url https://api2.recruso.co.uk/v1/workers/1/cpc-training \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "workerId": 4821, "trainingFrom": "2021-09-10", "trainingUntil": "2026-09-09", "completedByRequiredDate": false }'

Opens a Driver CPC training period for a worker in your own agency — the window the periodic training has to be completed in.

The period holds no training on its own: the modules completed within it are recorded against it one at a time, and the period reports how many there are and the hours they add up to.

Both dates are required, and TrainingUntil must not be before TrainingFrom. A worker id belonging to another agency returns 404 rather than 403, so their existence is never disclosed.

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

workerId
required
integer format: int32

The workerId path parameter

Media typeapplication/json

A Driver CPC training period to record for a worker.

object
workerId

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

integer format: int32
Example
4821
trainingFrom

The date the period starts. Required.

string format: date
Example
2021-09-10
trainingUntil

The date the period runs to. Required, and must not be before the start date — both columns are NOT NULL.

string format: date
Example
2026-09-09
completedByRequiredDate

Whether the required hours were completed within the period.

boolean
nullable
Example
false

Created

Media typeapplication/json
object
trainingId

The training period identifier.

integer format: int64
trainingFrom

The date the period starts.

string format: date
trainingUntil

The date the period runs to.

string format: date
completedByRequiredDate

Whether the required hours were completed within the period.

boolean
nullable
moduleCount

How many modules have been recorded in the period.

integer format: int32
totalHoursCompleted

The hours recorded across those modules.

number format: double
Example
{
"trainingId": 4410,
"trainingFrom": "2021-09-10",
"trainingUntil": "2026-09-09",
"completedByRequiredDate": false,
"moduleCount": 3,
"totalHoursCompleted": 21
}

Bad Request

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}