Advanced Search Report Booked Candidates

Advanced Search Report on finding Booked Candidates for a shift

post/agency/{agency_id}/advanced-search-report/booked-candidates

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency/{agency_id}/advanced-search-report/booked-candidates
  • Auth
    HTTP basic

Request body

site_idstring required
ward_idstring
job_title_idstring required
min_shift_date_bookedstring date-time

The query param to specify the minimum date for the range to be matched on start_date field, useful for doing 'shift in x days' queries

max_shift_date_bookedstring date-time

The query param to specify the maximum date for the range to be matched on start_date field, useful for doing 'shift in x days' queries

shift_start_datestring date-time required

The query param to specify the start date of the current shift, used to match override compliance

compliance_contract_idstring

Response

list of booked candidates based on search criteria

agency_idstring required
candidate_idstring required
candidate_full_namestring required
booking_countnumber required
last_shift_datestring date-time required
is_job_title_matchboolean required
compliance_status'NO_COMPLIANCE_CONTRACT_SET' | 'NOT_YET_COMPUTED' | 'NOT_APPLICABLE' | 'INCOMPLIANT' | 'COMPLIANT' required
exclusion_status'NOT_EXCLUDED' | 'EXCLUDED' | 'UNKNOWN' required

Changes

No recorded changes to this operation across all 3 revisions of this API.