POST api/Clients/AdminGetItems
Request Information
URI Parameters
None.
Body Parameters
GetClientItemsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Search | string |
None. |
|
| ActiveOnly | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Search": "sample string 1",
"ActiveOnly": true
}
application/xml, text/xml
Sample:
<GetClientItemsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Admin"> <ActiveOnly>true</ActiveOnly> <Search>sample string 1</Search> </GetClientItemsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetClientItemsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | Collection of AdminClientItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"Items": [
{
"ClientID": 1,
"ClientName": "sample string 2",
"ClientDescription": "sample string 3",
"ImageUrl": "sample string 4",
"IsActive": true
},
{
"ClientID": 1,
"ClientName": "sample string 2",
"ClientDescription": "sample string 3",
"ImageUrl": "sample string 4",
"IsActive": true
}
]
}
application/xml, text/xml
Sample:
<GetClientItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Admin">
<Items>
<AdminClientItem>
<ClientDescription>sample string 3</ClientDescription>
<ClientID>1</ClientID>
<ClientName>sample string 2</ClientName>
<ImageUrl>sample string 4</ImageUrl>
<IsActive>true</IsActive>
</AdminClientItem>
<AdminClientItem>
<ClientDescription>sample string 3</ClientDescription>
<ClientID>1</ClientID>
<ClientName>sample string 2</ClientName>
<ImageUrl>sample string 4</ImageUrl>
<IsActive>true</IsActive>
</AdminClientItem>
</Items>
</GetClientItemsResponse>