Agency Previously Booked Candidate Advanced Search

Advanced search on Agency Previously Booked Candidates

post/agency/{agency_id}/advanced-search/previously-booked-agency-candidate

Request

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

Request body

sortstring[]
pageinteger
items_per_pageinteger

Example request

{
  "query": {
    "and": [
      {
        "agency_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "organisation_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "site_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "site_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "ward_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "ward_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_full_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_type": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_status": {
          "status": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "status_id": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "date": {
            "equal": "2018-01-01T00:00:00Z",
            "greater_than": "2018-01-01T00:00:00Z",
            "less_than": "2018-01-01T00:00:00Z",
            "greater_than_equal": "2018-01-01T00:00:00Z",
            "less_than_equal": "2018-01-01T00:00:00Z",
            "in": [
              "2018-01-01T00:00:00Z"
            ]
          }
        },
        "candidate_type_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_title_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_title_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_family_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_family_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_link_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_status": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "last_shift_worked_at": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "next_shift_date": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "availability_last_updated_at": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "available": {
          "status": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "period": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "range_start": {
            "equal": "2018-01-01",
            "greater_than": "2018-01-01",
            "less_than": "2018-01-01",
            "greater_than_equal": "2018-01-01",
            "less_than_equal": "2018-01-01",
            "in": [
              "2018-01-01"
            ]
          },
          "range_end": {
            "equal": "2018-01-01",
            "greater_than": "2018-01-01",
            "less_than": "2018-01-01",
            "greater_than_equal": "2018-01-01",
            "less_than_equal": "2018-01-01",
            "in": [
              "2018-01-01"
            ]
          },
          "contains": [
            {
              "status": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "period": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "range_start": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              },
              "range_end": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              }
            }
          ],
          "contains_any": [
            {
              "status": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "period": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "range_start": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              },
              "range_end": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              }
            }
          ]
        }
      }
    ],
    "or": [
      {
        "agency_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "organisation_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "site_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "site_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "ward_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "ward_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_full_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_type": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "candidate_status": {
          "status": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "status_id": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "date": {
            "equal": "2018-01-01T00:00:00Z",
            "greater_than": "2018-01-01T00:00:00Z",
            "less_than": "2018-01-01T00:00:00Z",
            "greater_than_equal": "2018-01-01T00:00:00Z",
            "less_than_equal": "2018-01-01T00:00:00Z",
            "in": [
              "2018-01-01T00:00:00Z"
            ]
          }
        },
        "candidate_type_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_title_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_title_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_family_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "job_family_name": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_link_id": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "compliance_contract_status": {
          "like": "string",
          "equal": "string",
          "in": [
            "string"
          ],
          "nin": [
            "string"
          ],
          "greater_than": "string",
          "less_than": "string",
          "greater_than_equal": "string",
          "less_than_equal": "string"
        },
        "last_shift_worked_at": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "next_shift_date": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "availability_last_updated_at": {
          "equal": "2018-01-01T00:00:00Z",
          "greater_than": "2018-01-01T00:00:00Z",
          "less_than": "2018-01-01T00:00:00Z",
          "greater_than_equal": "2018-01-01T00:00:00Z",
          "less_than_equal": "2018-01-01T00:00:00Z",
          "in": [
            "2018-01-01T00:00:00Z"
          ]
        },
        "available": {
          "status": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "period": {
            "like": "string",
            "equal": "string",
            "in": [
              "string"
            ],
            "nin": [
              "string"
            ],
            "greater_than": "string",
            "less_than": "string",
            "greater_than_equal": "string",
            "less_than_equal": "string"
          },
          "range_start": {
            "equal": "2018-01-01",
            "greater_than": "2018-01-01",
            "less_than": "2018-01-01",
            "greater_than_equal": "2018-01-01",
            "less_than_equal": "2018-01-01",
            "in": [
              "2018-01-01"
            ]
          },
          "range_end": {
            "equal": "2018-01-01",
            "greater_than": "2018-01-01",
            "less_than": "2018-01-01",
            "greater_than_equal": "2018-01-01",
            "less_than_equal": "2018-01-01",
            "in": [
              "2018-01-01"
            ]
          },
          "contains": [
            {
              "status": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "period": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "range_start": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              },
              "range_end": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              }
            }
          ],
          "contains_any": [
            {
              "status": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "period": {
                "like": "string",
                "equal": "string",
                "in": [
                  "string"
                ],
                "nin": [
                  "string"
                ],
                "greater_than": "string",
                "less_than": "string",
                "greater_than_equal": "string",
                "less_than_equal": "string"
              },
              "range_start": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              },
              "range_end": {
                "equal": "2018-01-01",
                "greater_than": "2018-01-01",
                "less_than": "2018-01-01",
                "greater_than_equal": "2018-01-01",
                "less_than_equal": "2018-01-01",
                "in": [
                  "2018-01-01"
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Response

list of agency previously booked candidates based on search criteria

_idstring
agency_idstring
organisation_idstring
site_idstring
site_namestring
ward_idstring
ward_namestring
candidate_idstring
candidate_full_namestring
job_title_idstring
job_title_namestring
job_family_idstring
job_family_namestring
booking_countinteger
advanced_search_agency_client_no_collation_idstring
compliance_contract_idstring
compliance_contract_link_idstring
last_shift_worked_atstring date-time
next_shift_datestring date-time
candidate_typestring
candidate_type_idstring
compliance_contract_statusstring
currently_excludedboolean
exclusionsstring[]
compliantboolean
availability_last_updated_atstring date-time
created_atstring date-time
updated_atstring date-time
__vinteger

Changes

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