Global Search

Get agency global search suggestions

post/agency/{agency_id}/global-search-suggestions

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency/{agency_id}/global-search-suggestions
  • Auth
    HTTP basic and HTTP basic

Request body

index_typesstring[] required
search_termstring required
sizeinteger

Response

List of agency global search suggestions

Example response

{
  "results": [
    {
      "index_type": "client_site",
      "data": [
        {
          "_id": "5f4fc1aca3cd2b6e9f7d9dcd",
          "agency_id": "5b16b824e8a73a752c42d848",
          "client_id": "5b16b719e8a73a63f0031ff2",
          "client_type": "site",
          "agency_client_reference": "blcS1",
          "client_reference": "blackSite1",
          "client_name": "black site 1",
          "parent_name": "Black Org"
        },
        {
          "_id": "5f4fc1aca3cd2b7d0f7d9dd1",
          "agency_id": "5b16b824e8a73a752c42d848",
          "client_id": "5f11c0a5e8a73a098b7b19d2",
          "client_type": "site",
          "contact_numbers": [
            "+1352519123456"
          ],
          "emails": [
            "sample_email@a24testmail.com"
          ],
          "client_name": "Test site 4",
          "parent_name": "Black Org"
        }
      ]
    },
    {
      "index_type": "client_ward",
      "data": [
        {
          "_id": "613b59aecefd546d0819a54c",
          "agency_id": "5b16b824e8a73a752c42d848",
          "client_id": "5f7dd221bd3bba0a2a4484e2",
          "client_type": "ward",
          "contact_numbers": [
            "+1352519123456"
          ],
          "emails": [
            "sample_email@a24testmail.com"
          ],
          "client_reference": "blackWard3liong",
          "client_name": "Black ward 3 Long linked one",
          "parent_name": "Black site 3 with a very long name for reasons"
        }
      ]
    },
    {
      "index_type": "client_organisation",
      "data": [
        {
          "_id": "5f4fc1afa3cd2b2e467d9dd5",
          "agency_id": "5b16b824e8a73a752c42d848",
          "client_id": "5c472a6ae8a73a04a1685042",
          "client_type": "organisation",
          "contact_numbers": [
            "+1352519123456"
          ],
          "emails": [
            "sample_email@a24testmail.com"
          ],
          "client_name": "Black organisation two long"
        }
      ]
    },
    {
      "index_type": "candidate",
      "data": [
        {
          "candidate_id": "5ff6dff8f36cb02cf3793c62",
          "agency_id": "5b16b824e8a73a752c42d848",
          "full_name": "sample fullname",
          "contact_numbers": [
            "+1352519123456"
          ],
          "emails": [
            "sample_email@a24testmail.com"
          ],
          "employment_references": [
            "reference1",
            "reference2"
          ],
          "id_number": "123456666",
          "candidate_type_id": "gbr_care_course",
          "current_status": "Archived",
          "post_code": "123 456",
          "_id": "5b16b824e8a73a752c42d848_5ff6dff8f36cb02cf3793c62",
          "avatar_thumbnail_url": "someUrl"
        }
      ]
    },
    {
      "index_type": "shift",
      "data": [
        {
          "_id": "5e8e065388bdf7ac875e9a2c",
          "agency_id": "5b16b824e8a73a752c42d848",
          "order_reference": "GA43",
          "order_id": "5c3f04a2e8a73a723501c017",
          "shift_reference_number": "shiftRefNum55",
          "po_number": "BleepBloep6",
          "start_date": "2019-01-23T06:00:00.000Z",
          "site_name": "Black Site 1",
          "order_timezone": "Europe/London"
        }
      ]
    },
    {
      "index_type": "agency_client_package_of_care",
      "data": [
        {
          "_id": "613b59aecefd546d0819a54c",
          "agency_id": "5b16b824e8a73a752c42d848",
          "client_id": "5f7dd221bd3bba0a2a4484e2",
          "client_type": "ward",
          "service_user_first_name": "John",
          "service_user_last_name": "Smith",
          "service_user_preferred_name": "Johnny",
          "org_name": "Black Organisation",
          "site_name": "Black Site"
        }
      ]
    }
  ]
}

Changes

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