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.OrganisationSearchItem| Name | 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": "98a6f34a-0a01-4f6a-b580-067e34e44e5d",
"address": {
"id": "33286967-f2f1-4991-ba61-0daeca695344",
"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": "229138fa-906f-4119-86bc-906ef0c52986"
},
{
"id": "98a6f34a-0a01-4f6a-b580-067e34e44e5d",
"address": {
"id": "33286967-f2f1-4991-ba61-0daeca695344",
"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": "229138fa-906f-4119-86bc-906ef0c52986"
}
]
text/html
Sample:
[{"id":"98a6f34a-0a01-4f6a-b580-067e34e44e5d","address":{"id":"33286967-f2f1-4991-ba61-0daeca695344","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":"229138fa-906f-4119-86bc-906ef0c52986"},{"id":"98a6f34a-0a01-4f6a-b580-067e34e44e5d","address":{"id":"33286967-f2f1-4991-ba61-0daeca695344","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":"229138fa-906f-4119-86bc-906ef0c52986"}]