POST api/client/ClientsCounter
Получение значений счётчиков по клиентам на основании входных фильтров
Request Information
URI Parameters
None.
Body Parameters
ClientsCounterRequestName | Description | Type | Additional information |
---|---|---|---|
MinBalance |
Счётчик: минимальный активный баланс на карте клиента |
decimal number |
None. |
MaxBalance |
Счётчик: максимальный активный баланс на карте клиента |
decimal number |
None. |
Start |
Пагинация: номер записи, от которой показывать записи, включая указанную |
integer |
None. |
Length |
Пагинация: позиция от которой показывать записи, включая указанную |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "MinBalance": 1.0, "MaxBalance": 1.0, "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 1" }
application/xml, text/xml
Sample:
<ClientsCounterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request"> <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator> <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 1</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Length>1</Length> <MaxBalance>1</MaxBalance> <MinBalance>1</MinBalance> <Start>1</Start> </ClientsCounterRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ClientsCounterResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Количество записей всего в выборке |
integer |
None. |
TotalRowsSelect |
Количество записей в запросе |
integer |
None. |
Data |
Массив информации о клиентах |
Collection of ClientsCounterDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalRows": 1, "TotalRowsSelect": 1, "Data": [ { "Id": 1, "Client": 1, "Card": 1, "CardStatus": "sample string 1", "Balance": 1.0 }, { "Id": 1, "Client": 1, "Card": 1, "CardStatus": "sample string 1", "Balance": 1.0 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
Sample:
<ClientsCounterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response"> <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode> <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message> <Data> <ClientsCounterResponse.ClientsCounterDataRow> <Balance>1</Balance> <Card>1</Card> <CardStatus>sample string 1</CardStatus> <Client>1</Client> <Id>1</Id> </ClientsCounterResponse.ClientsCounterDataRow> <ClientsCounterResponse.ClientsCounterDataRow> <Balance>1</Balance> <Card>1</Card> <CardStatus>sample string 1</CardStatus> <Client>1</Client> <Id>1</Id> </ClientsCounterResponse.ClientsCounterDataRow> </Data> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </ClientsCounterResponse>