POST api/Clients/GetClients

Request Information

URI Parameters

None.

Body Parameters

GetClientsRequest

None.

Request Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<GetClientsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Clients.Integration" />

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetClientsResponse
NameDescriptionTypeAdditional information
Clients

Collection of Client

None.

Response Formats

application/json, text/json

Sample:
{
  "Clients": [
    {
      "ClientID": 1,
      "ClientDescription": "sample string 2",
      "ClientName": "sample string 3",
      "ImageUrl": "sample string 4",
      "IsActive": true
    },
    {
      "ClientID": 1,
      "ClientDescription": "sample string 2",
      "ClientName": "sample string 3",
      "ImageUrl": "sample string 4",
      "IsActive": true
    }
  ]
}

application/xml, text/xml

Sample:
<GetClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Clients.Integration">
  <Clients xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Clients">
    <d2p1:Client>
      <d2p1:ClientDescription>sample string 2</d2p1:ClientDescription>
      <d2p1:ClientID>1</d2p1:ClientID>
      <d2p1:ClientName>sample string 3</d2p1:ClientName>
      <d2p1:ImageUrl>sample string 4</d2p1:ImageUrl>
      <d2p1:IsActive>true</d2p1:IsActive>
    </d2p1:Client>
    <d2p1:Client>
      <d2p1:ClientDescription>sample string 2</d2p1:ClientDescription>
      <d2p1:ClientID>1</d2p1:ClientID>
      <d2p1:ClientName>sample string 3</d2p1:ClientName>
      <d2p1:ImageUrl>sample string 4</d2p1:ImageUrl>
      <d2p1:IsActive>true</d2p1:IsActive>
    </d2p1:Client>
  </Clients>
</GetClientsResponse>