GET api/organisations/clients/search/{text}?take={take}&skip={skip}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
text

string

Required

take

integer

None.

skip

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of API.Domain.ViewModels.Organisation.OrganisationSearchItem
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Address

API.Domain.ViewModels.Common.SiteAddress

None.

Name

string

None.

ExternalReference

string

None.

DefaultContactId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "5eb0c1ed-4433-4620-9883-448e2cb5aae6",
    "address": {
      "id": "f0ff7c96-8ca9-4f97-9297-8a0d5581df48",
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "address4": "sample string 4",
      "city": "sample string 5",
      "county": "sample string 6",
      "country": "sample string 7",
      "zip": "sample string 8"
    },
    "name": "sample string 2",
    "externalReference": "sample string 3",
    "defaultContactId": "bd56aa21-cfda-4170-9764-95f952026069"
  },
  {
    "id": "5eb0c1ed-4433-4620-9883-448e2cb5aae6",
    "address": {
      "id": "f0ff7c96-8ca9-4f97-9297-8a0d5581df48",
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "address4": "sample string 4",
      "city": "sample string 5",
      "county": "sample string 6",
      "country": "sample string 7",
      "zip": "sample string 8"
    },
    "name": "sample string 2",
    "externalReference": "sample string 3",
    "defaultContactId": "bd56aa21-cfda-4170-9764-95f952026069"
  }
]

text/html

Sample:
[{"id":"5eb0c1ed-4433-4620-9883-448e2cb5aae6","address":{"id":"f0ff7c96-8ca9-4f97-9297-8a0d5581df48","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"name":"sample string 2","externalReference":"sample string 3","defaultContactId":"bd56aa21-cfda-4170-9764-95f952026069"},{"id":"5eb0c1ed-4433-4620-9883-448e2cb5aae6","address":{"id":"f0ff7c96-8ca9-4f97-9297-8a0d5581df48","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"name":"sample string 2","externalReference":"sample string 3","defaultContactId":"bd56aa21-cfda-4170-9764-95f952026069"}]