GET api/organisations/clients/search/{text}?take={take}&skip={skip}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
text | string |
Required |
|
take | integer |
None. |
|
skip | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of API.Domain.ViewModels.Organisation.OrganisationSearchItemName | Description | Type | Additional 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": "31355d4d-4e84-440f-99bc-7b921b5e0c6d", "address": { "id": "f4417bbd-6414-46b4-bf07-0899886be950", "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": "eb12cb01-325a-4177-834a-ad158288ccd9" }, { "id": "31355d4d-4e84-440f-99bc-7b921b5e0c6d", "address": { "id": "f4417bbd-6414-46b4-bf07-0899886be950", "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": "eb12cb01-325a-4177-834a-ad158288ccd9" } ]
text/html
Sample:
[{"id":"31355d4d-4e84-440f-99bc-7b921b5e0c6d","address":{"id":"f4417bbd-6414-46b4-bf07-0899886be950","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":"eb12cb01-325a-4177-834a-ad158288ccd9"},{"id":"31355d4d-4e84-440f-99bc-7b921b5e0c6d","address":{"id":"f4417bbd-6414-46b4-bf07-0899886be950","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":"eb12cb01-325a-4177-834a-ad158288ccd9"}]