POST api/client/ClientsPagingInfo
Получение информации о клиентах, с пагинацией и входными фильтрами
Request Information
URI Parameters
None.
Body Parameters
ClientsPagingInfoRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
Report |
Признак, что запрос идёт для скачивания отчёта |
boolean |
None. |
RegBegDate |
Входной фильтр: начальная дата анализируемого периода регистрации |
date |
None. |
RegEndDate |
Входной фильтр: конечная дата анализируемого периода регистрации |
date |
None. |
Fio |
Входной фильтр: фио |
string |
None. |
Client |
Входной фильтр: идентификатор клиента |
integer |
None. |
Card |
Входной фильтр: номер карты |
integer |
None. |
Phone |
Входной фильтр: номер телефона |
integer |
None. |
Входной фильтр: емейл |
string |
None. |
|
Start |
Пагинация: последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.) |
integer |
None. |
Length |
Пагинация: количество записей, которые нужно вернуть |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "Report": true, "RegBegDate": "2024-04-29T18:19:20.2614382+03:00", "RegEndDate": "2024-04-29T18:19:20.2614382+03:00", "Fio": "sample string 2", "Client": 1, "Card": 1, "Phone": 1, "Email": "sample string 3", "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 4" }
application/xml, text/xml
<ClientsPagingInfoRequest 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 4</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Card>1</Card> <Client>1</Client> <Email>sample string 3</Email> <Fio>sample string 2</Fio> <Length>1</Length> <Phone>1</Phone> <PosCode>sample string 1</PosCode> <RegBegDate>2024-04-29T18:19:20.2614382+03:00</RegBegDate> <RegEndDate>2024-04-29T18:19:20.2614382+03:00</RegEndDate> <Report>true</Report> <Start>1</Start> </ClientsPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ClientsPagingInfoResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Количество записей, которые попали в выборку |
integer |
None. |
TotalRowsSelect |
Количество записей, которые вернулись в массиве ответа на запрос |
integer |
None. |
AllClients |
Всего клиентов |
integer |
None. |
Data |
Массив информации о клиентах |
Collection of ClientsPagingInfoDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "TotalRowsSelect": 1, "AllClients": 1, "Data": [ { "Id": 1, "ClientId": 1, "RegDate": "2024-04-29T18:19:20.386432+03:00", "PosName": "sample string 1", "Fio": "sample string 2", "Gender": "sample string 3", "BirthDate": "2024-04-29T18:19:20.386432+03:00", "Card": 1, "CardStatusName": "sample string 4", "Phone": 1, "AppRegistrator": "sample string 5", "LastMobileLogin": "2024-04-29T18:19:20.4020593+03:00", "AlowSms": true, "AllowPush": true, "AllowEmail": true, "AllowTelegramNot": true, "LastPurchaseDate": "2024-04-29T18:19:20.4020593+03:00", "LastPurchaseAmount": 1.0, "FullBalance": 1.0, "Balance": 1.0, "BalanceNoActive": 1.0, "BonusHolded": 1.0, "LevelName": "sample string 6", "CardTypeName": "sample string 7", "Rfm": "sample string 8", "ClientStatusName": "sample string 9", "ClientTypeName": "sample string 10", "Gain": 1.0, "Purchases": 1, "AvgCheque": 1.0, "PurchaseFrequency": 1.0, "RefundCount": 1, "RefundSum": 1.0, "Redeemed": 1.0, "RedeemCount": 1, "SertRedeem": 1.0, "SertCardPurchases": 1 }, { "Id": 1, "ClientId": 1, "RegDate": "2024-04-29T18:19:20.386432+03:00", "PosName": "sample string 1", "Fio": "sample string 2", "Gender": "sample string 3", "BirthDate": "2024-04-29T18:19:20.386432+03:00", "Card": 1, "CardStatusName": "sample string 4", "Phone": 1, "AppRegistrator": "sample string 5", "LastMobileLogin": "2024-04-29T18:19:20.4020593+03:00", "AlowSms": true, "AllowPush": true, "AllowEmail": true, "AllowTelegramNot": true, "LastPurchaseDate": "2024-04-29T18:19:20.4020593+03:00", "LastPurchaseAmount": 1.0, "FullBalance": 1.0, "Balance": 1.0, "BalanceNoActive": 1.0, "BonusHolded": 1.0, "LevelName": "sample string 6", "CardTypeName": "sample string 7", "Rfm": "sample string 8", "ClientStatusName": "sample string 9", "ClientTypeName": "sample string 10", "Gain": 1.0, "Purchases": 1, "AvgCheque": 1.0, "PurchaseFrequency": 1.0, "RefundCount": 1, "RefundSum": 1.0, "Redeemed": 1.0, "RedeemCount": 1, "SertRedeem": 1.0, "SertCardPurchases": 1 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<ClientsPagingInfoResponse 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> <AllClients>1</AllClients> <Data> <ClientsPagingInfoResponse.ClientsPagingInfoDataRow> <AllowEmail>true</AllowEmail> <AllowPush>true</AllowPush> <AllowTelegramNot>true</AllowTelegramNot> <AlowSms>true</AlowSms> <AppRegistrator>sample string 5</AppRegistrator> <AvgCheque>1</AvgCheque> <Balance>1</Balance> <BalanceNoActive>1</BalanceNoActive> <BirthDate>2024-04-29T18:19:20.386432+03:00</BirthDate> <BonusHolded>1</BonusHolded> <Card>1</Card> <CardStatusName>sample string 4</CardStatusName> <CardTypeName>sample string 7</CardTypeName> <ClientId>1</ClientId> <ClientStatusName>sample string 9</ClientStatusName> <ClientTypeName>sample string 10</ClientTypeName> <Fio>sample string 2</Fio> <FullBalance>1</FullBalance> <Gain>1</Gain> <Gender>sample string 3</Gender> <Id>1</Id> <LastMobileLogin>2024-04-29T18:19:20.4020593+03:00</LastMobileLogin> <LastPurchaseAmount>1</LastPurchaseAmount> <LastPurchaseDate>2024-04-29T18:19:20.4020593+03:00</LastPurchaseDate> <LevelName>sample string 6</LevelName> <Phone>1</Phone> <PosName>sample string 1</PosName> <PurchaseFrequency>1</PurchaseFrequency> <Purchases>1</Purchases> <RedeemCount>1</RedeemCount> <Redeemed>1</Redeemed> <RefundCount>1</RefundCount> <RefundSum>1</RefundSum> <RegDate>2024-04-29T18:19:20.386432+03:00</RegDate> <Rfm>sample string 8</Rfm> <SertCardPurchases>1</SertCardPurchases> <SertRedeem>1</SertRedeem> </ClientsPagingInfoResponse.ClientsPagingInfoDataRow> <ClientsPagingInfoResponse.ClientsPagingInfoDataRow> <AllowEmail>true</AllowEmail> <AllowPush>true</AllowPush> <AllowTelegramNot>true</AllowTelegramNot> <AlowSms>true</AlowSms> <AppRegistrator>sample string 5</AppRegistrator> <AvgCheque>1</AvgCheque> <Balance>1</Balance> <BalanceNoActive>1</BalanceNoActive> <BirthDate>2024-04-29T18:19:20.386432+03:00</BirthDate> <BonusHolded>1</BonusHolded> <Card>1</Card> <CardStatusName>sample string 4</CardStatusName> <CardTypeName>sample string 7</CardTypeName> <ClientId>1</ClientId> <ClientStatusName>sample string 9</ClientStatusName> <ClientTypeName>sample string 10</ClientTypeName> <Fio>sample string 2</Fio> <FullBalance>1</FullBalance> <Gain>1</Gain> <Gender>sample string 3</Gender> <Id>1</Id> <LastMobileLogin>2024-04-29T18:19:20.4020593+03:00</LastMobileLogin> <LastPurchaseAmount>1</LastPurchaseAmount> <LastPurchaseDate>2024-04-29T18:19:20.4020593+03:00</LastPurchaseDate> <LevelName>sample string 6</LevelName> <Phone>1</Phone> <PosName>sample string 1</PosName> <PurchaseFrequency>1</PurchaseFrequency> <Purchases>1</Purchases> <RedeemCount>1</RedeemCount> <Redeemed>1</Redeemed> <RefundCount>1</RefundCount> <RefundSum>1</RefundSum> <RegDate>2024-04-29T18:19:20.386432+03:00</RegDate> <Rfm>sample string 8</Rfm> <SertCardPurchases>1</SertCardPurchases> <SertRedeem>1</SertRedeem> </ClientsPagingInfoResponse.ClientsPagingInfoDataRow> </Data> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </ClientsPagingInfoResponse>