List the modules in a Driver CPC training period

GET

/v1/workers/{workerId}/cpc-training/{trainingId}/modules

curl --request GET \
  --url https://api2.recruso.co.uk/v1/workers/1/cpc-training/1/modules \
  --header 'Authorization: <Authorization>'

• Production

Returns every module recorded within one of a worker’s Driver CPC training periods in your own agency, earliest training date first, with the hours they add up to.

The list is not paged. A worker or period belonging to another agency returns 404 rather than 403, so its existence is never disclosed.

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

trainingId

required

integer format: int32

The trainingId path parameter

Responses

200

OK

Media typeapplication/json

Every module recorded within one Driver CPC training period.

object

workerId

The worker the period belongs to.

integer format: int32

trainingId

The training period the modules belong to.

integer format: int64

totalHoursCompleted

The hours recorded across every module listed.

number format: double

modules

The modules, earliest training date first.

Array<object>

One module completed within a Driver CPC training period.

object

trainingDetailsId

The module record identifier.

integer format: int64

trainingId

The training period the module belongs to. Null only for a legacy row that was never attached to one.

integer format: int64

nullable

trainingDate

The date the module was taken.

string format: date

trainingCentre

Where it was taken.

string

nullable

module

What the module covered.

string

nullable

hoursCompleted

The hours it counted for.

number format: double

nullable

Example

{
  "workerId": 4821,
  "trainingId": 4410,
  "totalHoursCompleted": 21,
  "modules": [
    {
      "trainingDetailsId": 8815,
      "trainingId": 4410,
      "trainingDate": "2024-02-19",
      "trainingCentre": "Northgate Driver Training, Salford",
      "module": "Tachograph rules and driver hours",
      "hoursCompleted": 7
    }
  ]
}

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