POST api/reports/PartnterAndPos
Отчёт по ключевым показателям точек продаж
Request Information
URI Parameters
None.
Body Parameters
TotalPagingInfoRequestName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор партнера, по точкам которого нужно вернуть данные |
integer |
None. |
Pos |
Идентификатор точки продаж, по которой нужно вернуть данные |
integer |
None. |
PartnerName |
Наименование партнера, по точкам которого нужно вернуть данные |
string |
None. |
PosName |
Наименование точки продаж, по которой нужно вернуть данные |
string |
None. |
Year |
Год, за который нужно вернуть данные |
integer |
None. |
AllYear |
Признак, что данные нужно вернуть за все года |
boolean |
None. |
Month |
Месяц, за который нужно вернуть данные |
byte |
None. |
BegMonth |
Начальный месяц периода |
byte |
None. |
EndMonth |
Конечный месяц периода |
byte |
None. |
Start |
Последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.) |
integer |
None. |
Length |
Количество записей, которые нужно вернуть |
integer |
None. |
Report |
Признак, что это отчёт |
boolean |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "Partner": 1, "Pos": 1, "PartnerName": "sample string 1", "PosName": "sample string 2", "Year": 1, "AllYear": true, "Month": 64, "BegMonth": 64, "EndMonth": 64, "Start": 1, "Length": 1, "Report": true, "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
<TotalPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.AnalyticsRequest"> <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 3</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <AllYear>true</AllYear> <BegMonth>64</BegMonth> <EndMonth>64</EndMonth> <Length>1</Length> <Month>64</Month> <Partner>1</Partner> <PartnerName>sample string 1</PartnerName> <Pos>1</Pos> <PosName>sample string 2</PosName> <Report>true</Report> <Start>1</Start> <Year>1</Year> </TotalPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PartnterAndPosReportResponseName | Description | Type | Additional information |
---|---|---|---|
Report |
Бинарные данные отчёта |
Collection of byte |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Report": "QEA=", "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<PartnterAndPosReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.ReportsResponse"> <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> <Report>QEA=</Report> </PartnterAndPosReportResponse>