GET api/Mobile/Clients?Search={Search}&Limit={Limit}
Load client records.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Search | string |
Default value is |
|
| Limit | integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
Collection of IBMS_Cloud_API.Controllers.MobileClientsController+ClientFields| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | string |
None. |
|
| ClientName | string |
None. |
|
| Reference | string |
None. |
|
| ActiveStatus | boolean |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| AddressLine3 | string |
None. |
|
| County | string |
None. |
|
| CityTown | string |
None. |
|
| Postcode | string |
None. |
|
| PhoneNumber | string |
None. |
|
| string |
None. |
||
| ContactName | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ClientID": "sample string 1",
"ClientName": "sample string 2",
"Reference": "sample string 3",
"ActiveStatus": true,
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"County": "sample string 8",
"CityTown": "sample string 9",
"Postcode": "sample string 10",
"PhoneNumber": "sample string 11",
"Email": "sample string 12",
"ContactName": "sample string 13"
},
{
"ClientID": "sample string 1",
"ClientName": "sample string 2",
"Reference": "sample string 3",
"ActiveStatus": true,
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"County": "sample string 8",
"CityTown": "sample string 9",
"Postcode": "sample string 10",
"PhoneNumber": "sample string 11",
"Email": "sample string 12",
"ContactName": "sample string 13"
}
]
text/html
Sample:
[{"ClientID":"sample string 1","ClientName":"sample string 2","Reference":"sample string 3","ActiveStatus":true,"AddressLine1":"sample string 5","AddressLine2":"sample string 6","AddressLine3":"sample string 7","County":"sample string 8","CityTown":"sample string 9","Postcode":"sample string 10","PhoneNumber":"sample string 11","Email":"sample string 12","ContactName":"sample string 13"},{"ClientID":"sample string 1","ClientName":"sample string 2","Reference":"sample string 3","ActiveStatus":true,"AddressLine1":"sample string 5","AddressLine2":"sample string 6","AddressLine3":"sample string 7","County":"sample string 8","CityTown":"sample string 9","Postcode":"sample string 10","PhoneNumber":"sample string 11","Email":"sample string 12","ContactName":"sample string 13"}]
application/xml, text/xml
Sample:
<ArrayOfMobileClientsController.ClientFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API.Controllers">
<MobileClientsController.ClientFields>
<ActiveStatus>true</ActiveStatus>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<CityTown>sample string 9</CityTown>
<ClientID>sample string 1</ClientID>
<ClientName>sample string 2</ClientName>
<ContactName>sample string 13</ContactName>
<County>sample string 8</County>
<Email>sample string 12</Email>
<PhoneNumber>sample string 11</PhoneNumber>
<Postcode>sample string 10</Postcode>
<Reference>sample string 3</Reference>
</MobileClientsController.ClientFields>
<MobileClientsController.ClientFields>
<ActiveStatus>true</ActiveStatus>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<CityTown>sample string 9</CityTown>
<ClientID>sample string 1</ClientID>
<ClientName>sample string 2</ClientName>
<ContactName>sample string 13</ContactName>
<County>sample string 8</County>
<Email>sample string 12</Email>
<PhoneNumber>sample string 11</PhoneNumber>
<Postcode>sample string 10</Postcode>
<Reference>sample string 3</Reference>
</MobileClientsController.ClientFields>
</ArrayOfMobileClientsController.ClientFields>