Candidate Booked Shifts
Listing of the candidate's booked shifts
get/candidate/{candidate_id}/booked-shifts
Query parameters
bExtraDataboolean
Whether additional properties are to be returned if they exist, or not
idstring
A single mongo id
sStaffingOrderIdstring
The staffing order id
sJobTitleNamestring
The job title name
sSiteNamestring
The site name
sSiteIdstring
The site id
sWardNamestring
The ward name
sWardIdstring
The ward id
dtStartstring date-time
The starting date of the shift
from-dtStartstring date-time
The from date for dtStart, inclusive
to-dtStartstring date-time
The to date for dtStart, exclusive
dtEndstring date-time
The ending date of the shift
from-dtEndstring date-time
The from date for dtEnd, inclusive
to-dtEndstring date-time
TThe to date for dtEnd, exclusive
sBookedCandidateNamestring
The booked candidate's name
sBookedCandidateIdstring
The booked candidate id
sBookedAgencyIdstring
The booked agency id
sBookedAgencyNamestring
The booked agency's name
pageinteger
The page of documents to be displayed
items_per_pageinteger
The number of documents per page
sortBystring[]
A comma separated list of fields indicating sort order id, dtStart, a negative sign reverses direction -id
Response
Candidate booked shifts listing
Changes
No recorded changes to this endpoint across all 1 revision of this API.