Update an availability status
const url = 'https://api2.recruso.co.uk/v1/availability-statuses/1';const options = { method: 'PUT', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"id":1,"availabilityStatusName":"example","awrSpecific":true,"displayInWorkerApp":true,"displayTextInWorkerApp":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api2.recruso.co.uk/v1/availability-statuses/1 \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "id": 1, "availabilityStatusName": "example", "awrSpecific": true, "displayInWorkerApp": true, "displayTextInWorkerApp": "example" }'Updates one of your agency’s availability statuses. An availability status marks what a worker is doing on a given day — available, on holiday, at the doctor, on paternity leave.
Send the complete record: the fields you supply replace the stored values.
The name must not already be in use by another of your agency’s records; a clash returns 400. The record’s own current name is allowed.
Once any availability entry in your agency uses the status, its name and its awrSpecific flag can no longer change, so an entry cannot be moved into or out of the statuses that affect a worker’s AWR parity after it was recorded. A change to either returns 400, naming the field; the other fields stay editable. A name counts as changed when it differs at all once surrounding spaces are removed, a change of case included; sending the stored name back unchanged is never refused.
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”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The id path parameter
Request Bodyrequired
Section titled “Request Bodyrequired”object
Whether AWR-specific breaks are applied to this status when a worker’s parity is calculated. The flag on its own is not enough: the status name must also be one of SICKNESS, JURY_SERVICE, MATERNITY, PATERNITY, ADOPTION or UNPAID_LEAVE, in upper case.
Whether this status is offered to workers in the Recruso Worker App, where a worker sets their own availability.
Examplegenerated
{ "id": 1, "availabilityStatusName": "example", "awrSpecific": true, "displayInWorkerApp": true, "displayTextInWorkerApp": "example"}Responses
Section titled “Responses”OK
object
Whether AWR-specific breaks are applied to this status when a worker’s parity is calculated. The flag on its own is not enough: the status name must also be one of SICKNESS, JURY_SERVICE, MATERNITY, PATERNITY, ADOPTION or UNPAID_LEAVE, in upper case.
Whether this status is offered to workers in the Recruso Worker App, where a worker sets their own availability.
Examplegenerated
{ "availabilityStatusId": 1, "availabilityStatusName": "example", "awrSpecific": true, "displayInWorkerApp": true, "displayTextInWorkerApp": "example"}Bad Request
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}