POST api/client/ClientInfoPos
Получение агрегированной информации о клиентах по магазинам (регистрация, основной магазин покупки и т.д.)
Request Information
URI Parameters
None.
Body Parameters
ClientInfoPosRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MainPurchasesPos |
Входной фильтр: идентификатор основного магазина покупки |
integer |
None. |
| RegPos |
Входной фильтр: идентификатор магазина, который зарегистрировал клиента |
integer |
None. |
| Client |
Входной фильтр: идентификатор клиента |
integer |
None. |
| Card |
Входной фильтр: номер карты |
integer |
None. |
| Phone |
Входной фильтр: номер телефона |
integer |
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
{
"MainPurchasesPos": 1,
"RegPos": 1,
"Client": 1,
"Card": 1,
"Phone": 1,
"Start": 1,
"Length": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 1"
}
application/xml, text/xml
<ClientInfoPosRequest 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> <Card>1</Card> <Client>1</Client> <Length>1</Length> <MainPurchasesPos>1</MainPurchasesPos> <Phone>1</Phone> <RegPos>1</RegPos> <Start>1</Start> </ClientInfoPosRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ClientInfoPosResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRows |
Количество записей, которые попали в выборку |
integer |
None. |
| TotalRowsSelect |
Количество записей, которые вернулись в массиве ответа на запрос |
integer |
None. |
| Data |
Массив выходных данных |
Collection of ClientInfoPosDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"TotalRows": 1,
"TotalRowsSelect": 1,
"Data": [
{
"Id": 1,
"ClientId": 1,
"RegPos": 1,
"RegPosName": "sample string 1",
"MainPurchasesPos": 1,
"MainPurchasesPosName": "sample string 2"
},
{
"Id": 1,
"ClientId": 1,
"RegPos": 1,
"RegPosName": "sample string 1",
"MainPurchasesPos": 1,
"MainPurchasesPosName": "sample string 2"
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<ClientInfoPosResponse 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>
<ClientInfoPosResponse.ClientInfoPosDataRow>
<ClientId>1</ClientId>
<Id>1</Id>
<MainPurchasesPos>1</MainPurchasesPos>
<MainPurchasesPosName>sample string 2</MainPurchasesPosName>
<RegPos>1</RegPos>
<RegPosName>sample string 1</RegPosName>
</ClientInfoPosResponse.ClientInfoPosDataRow>
<ClientInfoPosResponse.ClientInfoPosDataRow>
<ClientId>1</ClientId>
<Id>1</Id>
<MainPurchasesPos>1</MainPurchasesPos>
<MainPurchasesPosName>sample string 2</MainPurchasesPosName>
<RegPos>1</RegPos>
<RegPosName>sample string 1</RegPosName>
</ClientInfoPosResponse.ClientInfoPosDataRow>
</Data>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</ClientInfoPosResponse>