POST api/sertcard/SertcardSeriesPagingInfo
Получение информации о сериях сертификатов, с входными фильтрами и пагинацией
Request Information
URI Parameters
None.
Body Parameters
SertCardSeriesPagingInfoRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
Report |
Признак, что запрашивается отчёт, а не данные для таблицы |
boolean |
None. |
SertCardSeries |
Входной фильтр: идентификатор серии сертификатов |
integer |
None. |
SerdCardType |
Входной фильтр: тип сертификата |
byte |
None. |
AllowRefund |
Входной фильтр: разрешён возврат средств на сертификат при возврате товара, которым был оплачен сертификатом |
boolean |
None. |
AllowReuse |
Входной фильтр: разрешено переиспользование сертификата более чем 1 раз |
boolean |
None. |
AllowRefundPurchase |
Входной фильтр: разрешён возврат товара типа сертификат |
boolean |
None. |
Active |
Входной фильтр: активные серии |
boolean |
None. |
NoActive |
Входной фильтр: неактивные серии |
boolean |
None. |
SecretConfirm |
Входной фильтр: подтверждение списания средств пинкодом |
boolean |
None. |
BegDate |
Входной фильтр: начальная дата периода действия серии сертификатов |
date |
None. |
EndDate |
Входной фильтр: конечная дата периода действия серии сертификатов |
date |
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", "Report": true, "SertCardSeries": 1, "SerdCardType": 64, "AllowRefund": true, "AllowReuse": true, "AllowRefundPurchase": true, "Active": true, "NoActive": true, "SecretConfirm": true, "BegDate": "2025-02-06T15:09:05.6620646+03:00", "EndDate": "2025-02-06T15:09:05.6620646+03:00", "Start": 1, "Length": 1, "Operator": 1, "Token": 1, "SiteCode": "sample string 2" }
application/xml, text/xml
<SertCardSeriesPagingInfoRequest 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> <Active>true</Active> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <BegDate>2025-02-06T15:09:05.6620646+03:00</BegDate> <EndDate>2025-02-06T15:09:05.6620646+03:00</EndDate> <Length>1</Length> <NoActive>true</NoActive> <PosCode>sample string 1</PosCode> <Report>true</Report> <SecretConfirm>true</SecretConfirm> <SerdCardType>64</SerdCardType> <SertCardSeries>1</SertCardSeries> <Start>1</Start> </SertCardSeriesPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SertCardSeriesPagingInfoResponseName | Description | Type | Additional information |
---|---|---|---|
TotalRows |
Общее кол-во строк, которое может вернуться в выборке |
integer |
None. |
TotalRowsSelect |
Общее кол-во строк, которое вернулось в запросе |
integer |
None. |
Data |
Информация о сериях сертификатов |
Collection of SertCardSeriesPagingInfoDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "TotalRows": 1, "TotalRowsSelect": 1, "Data": [ { "Id": 1, "SertCardSeries": 1, "SertCardSeriesName": "sample string 1", "DateCreate": "2025-02-06T15:09:05.974564+03:00", "SertCardType": 64, "SertCardTypeName": "sample string 2", "AllowRefund": true, "AllowReuse": true, "AllowRefundPurchase": true, "NoActive": true, "BegDate": "2025-02-06T15:09:05.974564+03:00", "EndDate": "2025-02-06T15:09:05.974564+03:00", "ExpDays": 1, "Length": 64, "SertCardPrefix": 1, "CountNumber": 1, "PersonId": 1, "PersonName": "sample string 3", "GenerateNumberType": 64, "GenerateNumberTypeName": "sample string 4" }, { "Id": 1, "SertCardSeries": 1, "SertCardSeriesName": "sample string 1", "DateCreate": "2025-02-06T15:09:05.974564+03:00", "SertCardType": 64, "SertCardTypeName": "sample string 2", "AllowRefund": true, "AllowReuse": true, "AllowRefundPurchase": true, "NoActive": true, "BegDate": "2025-02-06T15:09:05.974564+03:00", "EndDate": "2025-02-06T15:09:05.974564+03:00", "ExpDays": 1, "Length": 64, "SertCardPrefix": 1, "CountNumber": 1, "PersonId": 1, "PersonName": "sample string 3", "GenerateNumberType": 64, "GenerateNumberTypeName": "sample string 4" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<SertCardSeriesPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SertCardResponse"> <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> <SertCardSeriesPagingInfoResponse.SertCardSeriesPagingInfoDataRow> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <BegDate>2025-02-06T15:09:05.974564+03:00</BegDate> <CountNumber>1</CountNumber> <DateCreate>2025-02-06T15:09:05.974564+03:00</DateCreate> <EndDate>2025-02-06T15:09:05.974564+03:00</EndDate> <ExpDays>1</ExpDays> <GenerateNumberType>64</GenerateNumberType> <GenerateNumberTypeName>sample string 4</GenerateNumberTypeName> <Id>1</Id> <Length>64</Length> <NoActive>true</NoActive> <PersonId>1</PersonId> <PersonName>sample string 3</PersonName> <SertCardPrefix>1</SertCardPrefix> <SertCardSeries>1</SertCardSeries> <SertCardSeriesName>sample string 1</SertCardSeriesName> <SertCardType>64</SertCardType> <SertCardTypeName>sample string 2</SertCardTypeName> </SertCardSeriesPagingInfoResponse.SertCardSeriesPagingInfoDataRow> <SertCardSeriesPagingInfoResponse.SertCardSeriesPagingInfoDataRow> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <BegDate>2025-02-06T15:09:05.974564+03:00</BegDate> <CountNumber>1</CountNumber> <DateCreate>2025-02-06T15:09:05.974564+03:00</DateCreate> <EndDate>2025-02-06T15:09:05.974564+03:00</EndDate> <ExpDays>1</ExpDays> <GenerateNumberType>64</GenerateNumberType> <GenerateNumberTypeName>sample string 4</GenerateNumberTypeName> <Id>1</Id> <Length>64</Length> <NoActive>true</NoActive> <PersonId>1</PersonId> <PersonName>sample string 3</PersonName> <SertCardPrefix>1</SertCardPrefix> <SertCardSeries>1</SertCardSeries> <SertCardSeriesName>sample string 1</SertCardSeriesName> <SertCardType>64</SertCardType> <SertCardTypeName>sample string 2</SertCardTypeName> </SertCardSeriesPagingInfoResponse.SertCardSeriesPagingInfoDataRow> </Data> <TotalRows>1</TotalRows> <TotalRowsSelect>1</TotalRowsSelect> </SertCardSeriesPagingInfoResponse>