List a worker's driving licences

GET

/v1/workers/{workerId}/licences

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

• Production

Returns every driving licence recorded for a worker in your own agency, oldest first, each with a count of the convictions against it.

Most workers hold one licence or none; the record allows several because a replacement licence is recorded rather than overwriting the one it replaces. The list is not paged. 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.

Authorizations

• Bearer

Parameters

Path Parameters

workerId

required

integer format: int32

The workerId path parameter

Responses

200

OK

Media typeapplication/json

Every driving licence held for a worker.

object

workerId

The worker the licences belong to.

integer format: int32

licences

The licences, oldest first.

Array<object>

A driving licence held by a worker.

object

workerLicenceId

The licence record’s identifier.

integer format: int64

licenceNumber

The licence number.

string

issueDate

The date the licence was issued.

string format: date

nullable

expiryDate

The date the licence expires.

string format: date

nullable

issueNumberChecked

Whether the issue number has been checked against the DVLA record.

boolean

nullable

convictionCount

How many convictions are recorded against this licence.

integer format: int32

Example

{
  "workerId": 4821,
  "licences": [
    {
      "workerLicenceId": 5120,
      "licenceNumber": "BAKER905124A99AB",
      "issueDate": "2019-06-03",
      "expiryDate": "2029-06-02",
      "issueNumberChecked": true,
      "convictionCount": 1
    }
  ]
}

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