Agency Client Advanced Search

Advanced search on Agency client

post/agency/{agency_id}/advanced-search/agency-client

Request

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

Request body

sortstring[]
pageinteger
items_per_pageinteger

Response

list of agency client based on search criteria

_idstring
linkedboolean
agency_idstring
organisation_idstring
organisation_namestring
site_idstring
site_namestring
ward_idstring
ward_namestring
node_levelstring
client_referencestring
site_type_idstring
site_type_namestring
ward_type_idstring
ward_type_namestring
site_address_line_1string
site_address_line_2string
site_provincestring
site_post_codestring
site_citystring
site_country_codestring
site_reference_numberstring
site_timezonestring
ward_reference_numberstring
compliance_contract_link_idstring
compliance_contract_idstring
compliance_contract_namestring
compliance_contract_descriptionstring
compliance_contract_statusstring
updated_atstring date-time
created_atstring date-time
__vinteger
has_payroll_contractboolean
has_active_payroll_contractboolean
next_shift_atstring date-time
previous_shift_atstring date-time
first_shift_atstring date-time
next_booking_atstring date-time
previous_booking_atstring date-time
first_booking_atstring date-time
payment_term'credit' | 'pay_in_advance'
payment_term_inheritedboolean required
financial_hold'applied' | 'cleared'
financial_hold_inheritedboolean required
has_pending_agency_verified_documentsboolean
package_of_care'initiated'

Example response

[
  {
    "site_physical_geo_location": {
      "coordinates": [
        18.577658,
        -33.907298
      ]
    }
  }
]

Changes

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