Skip to content
Recruso API

Create a day rate rule

POST
/v1/day-rate-rules
curl --request POST \
  --url https://api2.recruso.co.uk/v1/day-rate-rules \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dayRateRuleName": "example", "shiftHours": 1, "shiftRateTypeId": 1, "breakHours": 1, "overtimeAfterHours": 1, "overtimeRateTypeId": 1, "noOvertime": true }'

Creates a day rate rule for your agency. A day rate rule sets the work hours, break time, overtime and associated rates for one shift.

Names are not checked for uniqueness, so the same name can be used more than once.

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
dayRateRuleName
required
string
shiftHours
required
number format: double
nullable
shiftRateTypeId
required
integer format: int16
breakHours
required
number format: double
nullable
overtimeAfterHours
required
number format: double
nullable
overtimeRateTypeId
required
integer format: int16
nullable
noOvertime
required
boolean
nullable
Examplegenerated
{
  "dayRateRuleName": "example",
  "shiftHours": 1,
  "shiftRateTypeId": 1,
  "breakHours": 1,
  "overtimeAfterHours": 1,
  "overtimeRateTypeId": 1,
  "noOvertime": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
dayRateRuleId
required
integer format: int32
dayRateRuleName
required
string
nullable
shiftHours
required
number format: double
nullable
shiftRateTypeId
required
integer format: int16
breakHours
required
number format: double
nullable
overtimeAfterHours
required
number format: double
nullable
overtimeRateTypeId
required
integer format: int16
nullable
noOvertime
required
boolean
nullable
Examplegenerated
{
  "dayRateRuleId": 1,
  "dayRateRuleName": "example",
  "shiftHours": 1,
  "shiftRateTypeId": 1,
  "breakHours": 1,
  "overtimeAfterHours": 1,
  "overtimeRateTypeId": 1,
  "noOvertime": true
}

400

Section titled “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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Section titled “401”

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

403

Section titled “403”

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