Create a work detail label

POST

/v1/work-detail-labels

curl --request POST \
  --url https://api2.recruso.co.uk/v1/work-detail-labels \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dniLabel": "example", "hiVizLabel": "example", "specialRatesLabel": "example", "safetyBootsLabel": "example", "digitalTachoLabel": "example" }'

• Production

Creates a work detail label for your agency. Work detail labels rename the work-detail fields on a worker record. The five that can be relabelled are DNI, HiWiz, special rates, safety boots and digital tacho.

The name must not already be in use by another of your agency’s records; a clash returns 400 rather than creating a duplicate.

Returns 201 with the created record.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

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

Authorizations

• Bearer

Request Body^required

Media typeapplication/json

object

dniLabel

string

nullable

hiVizLabel

string

nullable

specialRatesLabel

string

nullable

safetyBootsLabel

string

nullable

digitalTachoLabel

string

nullable

Example^generated

{
  "dniLabel": "example",
  "hiVizLabel": "example",
  "specialRatesLabel": "example",
  "safetyBootsLabel": "example",
  "digitalTachoLabel": "example"
}

Responses

201

Created

Media typeapplication/json

object

workDetailId

integer format: int32

dniLabel

string

nullable

hiVizLabel

string

nullable

specialRatesLabel

string

nullable

safetyBootsLabel

string

nullable

digitalTachoLabel

string

nullable

Example^generated

{
  "workDetailId": 1,
  "dniLabel": "example",
  "hiVizLabel": "example",
  "specialRatesLabel": "example",
  "safetyBootsLabel": "example",
  "digitalTachoLabel": "example"
}

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