GET api/Portal/Clients

Load Client records.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of IBMS_Cloud_API.ClientModel+ClientFields

Name	Type	Additional information
ClientID	string	None.
ClientName	string	None.
StatusID	string	None.
StatusLabel	string	None.
Reference	string	None.
Phone	string	None.
CityTown	string	None.
Postcode	string	None.
TotalSites	string	None.
ActiveStatus	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": "sample string 1",
    "ClientName": "sample string 2",
    "StatusID": "sample string 3",
    "StatusLabel": "sample string 4",
    "Reference": "sample string 5",
    "Phone": "sample string 6",
    "CityTown": "sample string 7",
    "Postcode": "sample string 8",
    "TotalSites": "sample string 9",
    "ActiveStatus": 10
  },
  {
    "ClientID": "sample string 1",
    "ClientName": "sample string 2",
    "StatusID": "sample string 3",
    "StatusLabel": "sample string 4",
    "Reference": "sample string 5",
    "Phone": "sample string 6",
    "CityTown": "sample string 7",
    "Postcode": "sample string 8",
    "TotalSites": "sample string 9",
    "ActiveStatus": 10
  }
]

text/html

Sample:

[{"ClientID":"sample string 1","ClientName":"sample string 2","StatusID":"sample string 3","StatusLabel":"sample string 4","Reference":"sample string 5","Phone":"sample string 6","CityTown":"sample string 7","Postcode":"sample string 8","TotalSites":"sample string 9","ActiveStatus":10},{"ClientID":"sample string 1","ClientName":"sample string 2","StatusID":"sample string 3","StatusLabel":"sample string 4","Reference":"sample string 5","Phone":"sample string 6","CityTown":"sample string 7","Postcode":"sample string 8","TotalSites":"sample string 9","ActiveStatus":10}]

application/xml, text/xml

Sample:

<ArrayOfClientModel.ClientFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <ClientModel.ClientFields>
    <ActiveStatus>10</ActiveStatus>
    <CityTown>sample string 7</CityTown>
    <ClientID>sample string 1</ClientID>
    <ClientName>sample string 2</ClientName>
    <Phone>sample string 6</Phone>
    <Postcode>sample string 8</Postcode>
    <Reference>sample string 5</Reference>
    <StatusID>sample string 3</StatusID>
    <StatusLabel>sample string 4</StatusLabel>
    <TotalSites>sample string 9</TotalSites>
  </ClientModel.ClientFields>
  <ClientModel.ClientFields>
    <ActiveStatus>10</ActiveStatus>
    <CityTown>sample string 7</CityTown>
    <ClientID>sample string 1</ClientID>
    <ClientName>sample string 2</ClientName>
    <Phone>sample string 6</Phone>
    <Postcode>sample string 8</Postcode>
    <Reference>sample string 5</Reference>
    <StatusID>sample string 3</StatusID>
    <StatusLabel>sample string 4</StatusLabel>
    <TotalSites>sample string 9</TotalSites>
  </ClientModel.ClientFields>
</ArrayOfClientModel.ClientFields>