POST api/reports/SertcardData
Отчёт по подарочным сертификатам
Request Information
URI Parameters
None.
Body Parameters
SertcardPagingRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PosCode |
Код торговой точки |
string |
None. |
| Partner |
Фильтр: идентификатор партнёра |
integer |
None. |
| Report |
Признак, что запрашивается отчёт, а не данные для таблицы |
boolean |
None. |
| Free |
Фильтр: только свободные номера сертификатов |
boolean |
None. |
| NoFree |
Фильтр: только не свободные номера сертификатов |
boolean |
None. |
| BegExpDate |
Фильтр: дата начала периода сгорания сертификатов |
date |
None. |
| EndExpDate |
Фильтр: дата окончания периода сгорания сертификатов |
date |
None. |
| CountUsedMin |
Фильтр: минимальное количество использований сертификата |
integer |
None. |
| CountUsedMax |
Фильтр: максимальное количеств использований сертификата |
integer |
None. |
| RemainMin |
Фильтр: минимальный остаток на сертификате |
decimal number |
None. |
| RemainMax |
Фильтр: максимальный остаток на сертификате |
decimal number |
None. |
| Phone |
Фильтр: номер телефона клиента |
integer |
None. |
| SertCard |
Фильтр: номер подарочного сертификата |
integer |
None. |
| SertCardStatus |
Фильтр: идентификатор статуса подарочного сертификата |
byte |
None. |
| SertCardSeries |
Фильтр: идентификатор серии подарочного сертификата |
integer |
None. |
| SertCardStatusPurchase |
Фильтр: тип подарочного сертификата |
byte |
None. |
| Nominal |
Фильтр: номинал сертификата |
decimal number |
None. |
| SertCardType |
Фильтр: иденитфикатор типа подарочного сертификата |
byte |
None. |
| SertCardOwner |
Фильтр: идентификатор владельца сертификата (актуально для эл. сертификатов, купленных через виджет) |
integer |
None. |
| Client |
Фильтр: идентификатор клиента |
integer |
None. |
| Start |
Пагинация: начальная позиция для отображения |
integer |
None. |
| Length |
Пагинация: кол-во строк для отображения |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"PosCode": "sample string 1",
"Partner": 1,
"Report": true,
"Free": true,
"NoFree": true,
"BegExpDate": "2025-12-22T09:24:08.0179915+03:00",
"EndExpDate": "2025-12-22T09:24:08.0179915+03:00",
"CountUsedMin": 1,
"CountUsedMax": 1,
"RemainMin": 1.0,
"RemainMax": 1.0,
"Phone": 1,
"SertCard": 1,
"SertCardStatus": 64,
"SertCardSeries": 1,
"SertCardStatusPurchase": 64,
"Nominal": 1.0,
"SertCardType": 64,
"SertCardOwner": 1,
"Client": 1,
"Start": 1,
"Length": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 2"
}
application/xml, text/xml
<SertcardPagingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SertCardRequest"> <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> <BegExpDate>2025-12-22T09:24:08.0179915+03:00</BegExpDate> <Client>1</Client> <CountUsedMax>1</CountUsedMax> <CountUsedMin>1</CountUsedMin> <EndExpDate>2025-12-22T09:24:08.0179915+03:00</EndExpDate> <Free>true</Free> <Length>1</Length> <NoFree>true</NoFree> <Nominal>1</Nominal> <Partner>1</Partner> <Phone>1</Phone> <PosCode>sample string 1</PosCode> <RemainMax>1</RemainMax> <RemainMin>1</RemainMin> <Report>true</Report> <SertCard>1</SertCard> <SertCardOwner>1</SertCardOwner> <SertCardSeries>1</SertCardSeries> <SertCardStatus>64</SertCardStatus> <SertCardStatusPurchase>64</SertCardStatusPurchase> <SertCardType>64</SertCardType> <Start>1</Start> </SertcardPagingRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SertcardDataReportResponse| Name | 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
<SertcardDataReportResponse 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> </SertcardDataReportResponse>