POST api/level/LevelsStatistics
Получение статистической информации об уровнях карт в программе лояльности: кол-во клиентов на уровнях, подтверждение и пересчёт уровней по месяцам
Request Information
URI Parameters
None.
Body Parameters
LevelsStatisticsRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
LevelConfirm |
Признак, что нужно вернуть массив "подтверждений" уровней |
boolean |
None. |
LevelRecount |
Признак, что нужно вернуть массив "пересчета" уровней |
boolean |
None. |
LevelFromClient |
Признак, что нужно вернуть массив "клиентов на уровнях" |
boolean |
None. |
ProcMonth |
Месяц за который нужно вернуть данные |
byte |
None. |
ProcYear |
Год за который нужно вернуть данные |
integer |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "LevelConfirm": true, "LevelRecount": true, "LevelFromClient": true, "ProcMonth": 64, "ProcYear": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<LevelsStatisticsRequest 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 2</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <LevelConfirm>true</LevelConfirm> <LevelFromClient>true</LevelFromClient> <LevelRecount>true</LevelRecount> <PosCode>sample string 1</PosCode> <ProcMonth>64</ProcMonth> <ProcYear>1</ProcYear> </LevelsStatisticsRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
LevelsStatisticsResponseName | Description | Type | Additional information |
---|---|---|---|
ClientsData |
Массив "Клиенты на уровнях" |
Collection of LevelsStatisticsClientsDataStr |
None. |
RecountData |
Массив "Пересчёт уровней" |
Collection of LevelsStatisticsRecountDataStr |
None. |
ConfirmData |
Массив "Подтверждение уровней" |
Collection of LevelsStatisticsConfirmDataStr |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "ClientsData": [ { "Id": 1, "Name": "sample string 1", "Condition": "sample string 2", "Threshold": 1.0, "LevelStep": 64, "CountClients": 1, "AvgCheque": 1.0 }, { "Id": 1, "Name": "sample string 1", "Condition": "sample string 2", "Threshold": 1.0, "LevelStep": 64, "CountClients": 1, "AvgCheque": 1.0 } ], "RecountData": [ { "Id": 1, "LevelsUp": 1, "LevelsDown": 1, "LevelsContinue": 1, "ProcMonth": 64, "ProcWeek": 64, "ProcQuater": 64, "ProcHalfYear": 64, "ProcYear": 1 }, { "Id": 1, "LevelsUp": 1, "LevelsDown": 1, "LevelsContinue": 1, "ProcMonth": 64, "ProcWeek": 64, "ProcQuater": 64, "ProcHalfYear": 64, "ProcYear": 1 } ], "ConfirmData": [ { "Id": 1, "CountConfirm": 1, "CountNoConfirm": 1, "CountNoProcess": 1, "ProcMonth": 64, "ProcQuater": 64, "ProcHalfYear": 64, "ProcYear": 1 }, { "Id": 1, "CountConfirm": 1, "CountNoConfirm": 1, "CountNoProcess": 1, "ProcMonth": 64, "ProcQuater": 64, "ProcHalfYear": 64, "ProcYear": 1 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<LevelsStatisticsResponse 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> <ClientsData> <LevelsStatisticsResponse.LevelsStatisticsClientsDataStr> <AvgCheque>1</AvgCheque> <Condition>sample string 2</Condition> <CountClients>1</CountClients> <Id>1</Id> <LevelStep>64</LevelStep> <Name>sample string 1</Name> <Threshold>1</Threshold> </LevelsStatisticsResponse.LevelsStatisticsClientsDataStr> <LevelsStatisticsResponse.LevelsStatisticsClientsDataStr> <AvgCheque>1</AvgCheque> <Condition>sample string 2</Condition> <CountClients>1</CountClients> <Id>1</Id> <LevelStep>64</LevelStep> <Name>sample string 1</Name> <Threshold>1</Threshold> </LevelsStatisticsResponse.LevelsStatisticsClientsDataStr> </ClientsData> <ConfirmData> <LevelsStatisticsResponse.LevelsStatisticsConfirmDataStr> <CountConfirm>1</CountConfirm> <CountNoConfirm>1</CountNoConfirm> <CountNoProcess>1</CountNoProcess> <Id>1</Id> <ProcHalfYear>64</ProcHalfYear> <ProcMonth>64</ProcMonth> <ProcQuater>64</ProcQuater> <ProcYear>1</ProcYear> </LevelsStatisticsResponse.LevelsStatisticsConfirmDataStr> <LevelsStatisticsResponse.LevelsStatisticsConfirmDataStr> <CountConfirm>1</CountConfirm> <CountNoConfirm>1</CountNoConfirm> <CountNoProcess>1</CountNoProcess> <Id>1</Id> <ProcHalfYear>64</ProcHalfYear> <ProcMonth>64</ProcMonth> <ProcQuater>64</ProcQuater> <ProcYear>1</ProcYear> </LevelsStatisticsResponse.LevelsStatisticsConfirmDataStr> </ConfirmData> <RecountData> <LevelsStatisticsResponse.LevelsStatisticsRecountDataStr> <Id>1</Id> <LevelsContinue>1</LevelsContinue> <LevelsDown>1</LevelsDown> <LevelsUp>1</LevelsUp> <ProcHalfYear>64</ProcHalfYear> <ProcMonth>64</ProcMonth> <ProcQuater>64</ProcQuater> <ProcWeek>64</ProcWeek> <ProcYear>1</ProcYear> </LevelsStatisticsResponse.LevelsStatisticsRecountDataStr> <LevelsStatisticsResponse.LevelsStatisticsRecountDataStr> <Id>1</Id> <LevelsContinue>1</LevelsContinue> <LevelsDown>1</LevelsDown> <LevelsUp>1</LevelsUp> <ProcHalfYear>64</ProcHalfYear> <ProcMonth>64</ProcMonth> <ProcQuater>64</ProcQuater> <ProcWeek>64</ProcWeek> <ProcYear>1</ProcYear> </LevelsStatisticsResponse.LevelsStatisticsRecountDataStr> </RecountData> </LevelsStatisticsResponse>