Jobs Service

Creation / Modification

MethodPathAuthDetails
POST /jobs/create-shift

Description

POST /jobs/edit-shift

Description

POST /jobs/cancel

Description

POST /jobs/update-banks-and-agencies

Description

Applications & Bookings

MethodPathAuthDetails
POST /jobs/applycandidate

Description

Called when a candidate applies for a shift

Auth

User TypeReq. PermissionsDetails
Candidate-Can apply for a shift.

Parameters

NameTypeDefaultDescription
shiftKeyString (FirebaseId)requiredThe key of the shift the candidate is applying to.
POST /jobs/declinecandidate

Description

Cancels a candidate's booking from a shift (if candidate is already booked) or withdraws an application if not booked.

Auth

User TypeReq. PermissionsDetails
Candidate-

Parameters

NameTypeDefaultDescription
shiftKeyString (FirebaseId)requiredThe key of the shift the candidate is declining from.
reasonString (FirebaseId)requiredReason for candidate cancelling their booking. Not required if only withdrawing an application.
POST /jobs/bookadmin
candidate

Description

Book a candidate into a shift

Auth

User TypeReq. PermissionsDetails
Adminshifts.can_manage_shifts
staff.can_view_staff
Can book staff who are members of banks that they have access to (or any submitted agency candidate) into shifts they have `can_manage_shifts` permission over.
Candidate-Can book themselves if org is configured to allow this.

Parameters

NameTypeDefaultDescription
shiftKeyString (FirebaseId)requiredThe key of the shift to book the specified candidate to.
candidateIdString (FirebaseId)-The key of the candidate to book to the shift. Required if called by an admin. If called by a candidate then their ID is used.
isAgencyboolean-Whether the candidate is an agency candidate or not.
POST /jobs/submit-supplier-candidate

Description

POST /jobs/cancel-attempt

Description

POST /jobs/cancel-slots

Description

POST /applications/hide-or-unhide

Description

Viewing (Admins)

MethodPathAuthDetails
GET /calendars/day-summariesadmin

Description

Returns a summary of shifts based on the provided filters. Called by the web app and the result is displayed in the shifts calendar.

Auth

User TypeReq. PermissionsDetails
Admin-Shifts filtered by shift groups the admin has `can_view_shifts` shift permission over

Parameters

NameTypeDefaultDescription
startDateString (YYYY-MM-DD)requiredStart of date range
endDateString (YYYY-MM-DD)requiredEnd of date range
renderShiftKeysBooleanrequiredShould the shiftKeys for each shift be included in the response?
serviceIdsString[]requiredInclude only shifts that match the specified service keys.
siteIdsString[]requiredInclude only shifts that match the specified site keys.
areaIdsString[]requiredInclude only shifts that match the specified area keys.
roleIdsString[]requiredInclude only shifts that match the specified role keys.
gradeIdsString[]requiredInclude only shifts that match the specified grade keys.
specialityIdsString[]requiredInclude only shifts that match the specified specialty keys.
reasonIdsString[]requiredInclude only shifts that match the specified reason keys.
POST /jobs/shift-list

Description

GET /jobs/shift-detail

Description

GET /jobs/audit-trail

Description

GET /jobs/search

Description

Viewing (Staff)

MethodPathAuthDetails
GET /jobs/shift-list-candidate

Description

POST /jobs/shift-detail-candidate

Description

POST /jobs/candidate-shifts

Description

POST /jobs/increment-views

Description

Agency Management

MethodPathAuthDetails
POST /jobs/agency-approve

Description

POST /jobs/agency-release

Description

POST /jobs/agency-request

Description

POST /jobs/agency-retract

Description

Templates

MethodPathAuthDetails
POST /templates/create

Description

POST /templates/delete

Description

GET /templates/get

Description

GET /templates/list

Description

POST /templates/update

Description

Miscellaneous

MethodPathAuthDetails
POST /candidates/search

Description

POST /cost-centres/search

Description

POST /jobs/fetch-reasons

Description