GET api/ConsumerDevice/list?Distributor={Distributor}&ConsumerName={ConsumerName}&Device={Device}&TankTemplate={TankTemplate}&SerialNo={SerialNo}
Get all consumer Device
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Distributor |
Set default value = ""(Blank) Otherwise set CompanyName for filter |
string |
Required |
| ConsumerName |
Set default value = ""(Blank) Otherwise set ConsumerName for filter |
string |
Required |
| Device |
Set default value = ""(Blank) Otherwise set Device for filter |
string |
Required |
| TankTemplate |
Set default value = ""(Blank) Otherwise set TankTemplate for filter |
string |
Required |
| SerialNo | string |
Required |
Body Parameters
CommonParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| PageIndex |
set value = 1 for viewing first page records. change as per pagesize and number of records. |
integer |
Required |
| PageSize |
Set value = 15. Possible values between 15 to 100 |
integer |
Required |
| SortExp |
Set value = "CreatedDateTime". Possible value will be based on API Method's response data columns. |
string |
Required |
| SortDir |
Set value = "desc". Possible values will be "asc" or "desc" for sorting records |
string |
Required |
| Keyword |
set value = "" (blank). Possible value will be any words. |
string |
None. |
Request Formats
application/json, text/json
{
"PageIndex": 1,
"PageSize": 2,
"SortExp": "sample string 3",
"SortDir": "sample string 4",
"Keyword": "sample string 5"
}
application/xml, text/xml
<CommonParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sscTeklekWebAPI.Models"> <Keyword>sample string 5</Keyword> <PageIndex>1</PageIndex> <PageSize>2</PageSize> <SortDir>sample string 4</SortDir> <SortExp>sample string 3</SortExp> </CommonParameters>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.