--- title: "Advanced search on Agency Candidate Possible Shifts" method: POST path: "/agency/{agency_id}/advanced-search/candidate-possible-shifts" tags: ["Agency Candidate Possible Shifts Advanced Search"] --- # Advanced search on Agency Candidate Possible Shifts `POST /agency/{agency_id}/advanced-search/candidate-possible-shifts` ## Request - Base URL: `http://localhost:3010/v1` - URL: `http://localhost:3010/v1/agency/{agency_id}/advanced-search/candidate-possible-shifts` - Auth: HTTP basic ## Request body - AgencyCandidatePossibleShiftsAdvancedSearchQuery - `sort` string[] - `page` integer - `items_per_page` integer - `query` object - `and` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `and` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `or` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `shift_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `shift_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `user_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `username` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_type_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `shift_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_display_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_locale` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_reference` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `org_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `org_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_shift_status` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_modified_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `order_created_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `is_compliant` AdvancedSearchOperationsBooleanField - `equal` boolean - `site_partial_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `distance` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `candidate_physical_address_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `min_distance` integer: The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `site_address_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `min_distance` integer: The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `current_status` AdvancedSearchCurrentStatusQueryFields - `status` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `status_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `agency_contact_info` AdvancedSearchAgencyContactInfoQueryFields - `compliance_tel_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `staffing_tel_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_breakdown` AdvancedSearchEmbeddedQueryContractBreakdownQueryFields - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contains` AdvancedSearchContractBreakdownQueryFields[] - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contains_any` AdvancedSearchContractBreakdownQueryFields[] - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_info` AdvancedSearchContractInfoQueryFields - `contract_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_version` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_link_id` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `vat_applicable` AdvancedSearchOperationsBooleanField - `equal` boolean - `unit` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `initial_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `final_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate_summary` AdvancedSearchPayRateSummaryQueryFields - `high` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `low` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `unit` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `position_description` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `staffing_instructions` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `or` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `and` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `or` AgencyCandidatePossibleShiftsAdvancedSearchQueryFields[] - `shift_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `shift_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `user_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `username` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_type_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `shift_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_order_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_display_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_locale` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_title_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_family_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_reference` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `org_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `org_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `agency_shift_status` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `ward_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `order_modified_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `order_created_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `is_compliant` AdvancedSearchOperationsBooleanField - `equal` boolean - `site_partial_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `distance` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `candidate_physical_address_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `min_distance` integer: The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `site_address_geo_location` AdvancedSearchOperationsGeoLocationField - `equal` unknown - `near` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `min_distance` integer: The min distance a location should be away from the specified location. - `within` object - `coordinates` number[], required: Array containing geo location in this form: [ , ] - `max_distance` integer, required: The max distance a location can be away from the specified location. - `current_status` AdvancedSearchCurrentStatusQueryFields - `status` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `status_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `agency_contact_info` AdvancedSearchAgencyContactInfoQueryFields - `compliance_tel_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `staffing_tel_number` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_breakdown` AdvancedSearchEmbeddedQueryContractBreakdownQueryFields - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contains` AdvancedSearchContractBreakdownQueryFields[] - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contains_any` AdvancedSearchContractBreakdownQueryFields[] - `start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `min_duration` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `job_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_info` AdvancedSearchContractInfoQueryFields - `contract_id` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_name` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `contract_version` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `contract_link_id` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `vat_applicable` AdvancedSearchOperationsBooleanField - `equal` boolean - `unit` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `initial_start_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `final_end_date` AdvancedSearchOperationsDateField - `equal` string, date-time, nullable - `greater_than` string, date-time, nullable - `less_than` string, date-time, nullable - `greater_than_equal` string, date-time, nullable - `less_than_equal` string, date-time, nullable - `in` string[] - `currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `pay_rate_summary` AdvancedSearchPayRateSummaryQueryFields - `high` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `low` AdvancedSearchOperationsNumberField - `equal` number, nullable - `greater_than` number, nullable - `less_than` number, nullable - `greater_than_equal` number, nullable - `less_than_equal` number, nullable - `in` number[] - `nin` number[] - `unit` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `currency` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `site_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_post_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_country_code` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_province` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `candidate_city` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `position_description` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `staffing_instructions` AdvancedSearchOperationsStringField - `like` string, nullable - `equal` string, nullable - `in` string[] - `nin` string[] - `greater_than` string, nullable - `less_than` string, nullable - `greater_than_equal` string, nullable - `less_than_equal` string, nullable - `project` object - `user_id` 1 - `username` 1 - `candidate_id` 1, required - `candidate_physical_address_geo_location` 1 - `candidate_type_id` 1 - `current_status` 1 - `shift_id` 1, required - `order_id` 1, required - `agency_order_id` 1 - `agency_id` 1, required - `agency_avatar_url` 1 - `agency_display_name` 1 - `agency_locale` 1 - `agency_contact_info` 1 - `job_family_id` 1 - `job_family_name` 1 - `job_title_id` 1 - `job_title_name` 1 - `order_reference` 1 - `org_id` 1 - `org_name` 1 - `agency_shift_status` 1 - `site_id` 1 - `site_name` 1 - `site_address_geo_location` 1 - `ward_id` 1 - `ward_name` 1 - `shift_end_date` 1, required - `shift_start_date` 1, required - `order_created_date` 1 - `order_modified_date` 1 - `contract_breakdown` 1 - `contract_info` 1 - `is_compliant` 1 - `site_partial_post_code` 1 - `pay_rate_summary` 1 - `distance` 1 - `site_post_code` 1 - `site_country_code` 1 - `site_province` 1 - `site_address_line_1` 1 - `site_address_line_2` 1 - `site_city` 1 - `candidate_post_code` 1 - `candidate_country_code` 1 - `candidate_province` 1 - `candidate_address_line_1` 1 - `candidate_address_line_2` 1 - `candidate_city` 1 - `position_description` 1 - `staffing_instructions` 1 - `compliance_contract_id` 1 ## Response `200` list of agency candidate possible shift based on search criteria - AgencyCandidatePossibleShiftsAdvancedSearchResult[] - `_id` string - `user_id` string - `username` string - `candidate_id` string - `candidate_physical_address_geo_location` AddressGeoLocationSchema - `type` string - `coordinates` number[] - `candidate_type_id` string - `current_status` object - `status` string - `status_id` string - `date` string, date-time - `shift_id` string - `order_id` string - `agency_id` string - `agency_order_id` string - `agency_avatar_url` string - `agency_display_name` string - `agency_locale` string - `agency_contact_info` object - `compliance_tel_number` string - `staffing_tel_number` string - `job_family_id` string - `job_family_name` string - `job_title_id` string - `job_title_name` string - `order_reference` string - `org_id` string - `org_name` string - `agency_shift_status` string - `site_id` string - `site_name` string - `site_address_geo_location` AddressGeoLocationSchema - `type` string - `coordinates` number[] - `ward_id` string - `ward_name` string - `shift_end_date` string, date-time - `shift_start_date` string, date-time - `order_created_date` string, date-time - `order_modified_date` string, date-time - `contract_breakdown` object[] - `start_date` string, date-time - `end_date` string, date-time - `min_duration` string - `job_code` string - `pay_rate` number - `contract_info` object - `contract_id` string - `contract_name` string - `contract_version` number - `contract_link_id` string - `vat_applicable` boolean - `unit` string - `initial_start_date` string, date-time - `final_end_date` string, date-time - `currency` string - `is_compliant` boolean - `pay_rate_summary` object - `high` number - `low` number - `unit` string - `currency` string - `distance` number - `site_partial_post_code` string - `site_post_code` string - `site_country_code` string - `site_province` string - `site_address_line_1` string - `site_address_line_2` string - `site_city` string - `candidate_post_code` string - `candidate_country_code` string - `candidate_province` string - `candidate_address_line_1` string - `candidate_address_line_2` string - `candidate_city` string - `position_description` string - `staffing_instructions` string - `compliance_contract_id` string ## Other responses - `204`: No content - `400`: Validation Error. Usually caused by a missing or invalid parameter. - `401`: Failed to authenticate the user making the request - `403`: Permission denied error - `default`: Server error occurred --- [API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) - [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)