POST api/coupon/PagingInfo
Получение информации о купонах с входными фильтрами и пагинацией
Request Information
URI Parameters
None.
Body Parameters
CouponRequestPagingInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| CouponSeries |
Входной фильтр: идентификатор серии купонов |
integer |
None. |
| Coupon |
Входной фильтр: наименование купона |
string |
None. |
| CouponStatus |
Входной фильтр: идентификатор статуса купона |
integer |
None. |
| Client |
Входной фильтр: идентификатор клиента |
integer |
None. |
| NoFree |
Входной фильтр: статус занятости купона |
boolean |
None. |
| CountUsedMore |
Входной фильтр: количество использований купона "от" |
integer |
None. |
| Start |
Фильтр: с какой позиции вернуть записи |
integer |
None. |
| Length |
Фильтр: какое количество записей вернуть |
integer |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"CouponSeries": 1,
"Coupon": "sample string 1",
"CouponStatus": 1,
"Client": 1,
"NoFree": true,
"CountUsedMore": 1,
"Start": 1,
"Length": 1,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 2"
}
application/xml, text/xml
<PagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.CouponRequest"> <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> <Client>1</Client> <CountUsedMore>1</CountUsedMore> <Coupon>sample string 1</Coupon> <CouponSeries>1</CouponSeries> <CouponStatus>1</CouponStatus> <Length>1</Length> <NoFree>true</NoFree> <Start>1</Start> </PagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CouponResponsePagingInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRows |
Общее количество записей, которые можно вернуть после применения всех фильтров |
integer |
None. |
| TotalRowsSelect |
Общее количество записей, которые вернулись в конкретном запросе с пагинацией |
integer |
None. |
| Data |
Массив данных |
Collection of CouponRespDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"TotalRows": 1,
"TotalRowsSelect": 1,
"Data": [
{
"Id": 1,
"CouponId": 1,
"CouponSeries": 1,
"CouponSeriesName": "sample string 1",
"Coupon": "sample string 2",
"NoFree": true,
"CouponStatus": 64,
"CouponStatusName": "sample string 3",
"CountUsed": 1,
"Client": 1
},
{
"Id": 1,
"CouponId": 1,
"CouponSeries": 1,
"CouponSeriesName": "sample string 1",
"Coupon": "sample string 2",
"NoFree": true,
"CouponStatus": 64,
"CouponStatusName": "sample string 3",
"CountUsed": 1,
"Client": 1
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<PagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.CouponResponse">
<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>
<CouponRespDataRow>
<Client>1</Client>
<CountUsed>1</CountUsed>
<Coupon>sample string 2</Coupon>
<CouponId>1</CouponId>
<CouponSeries>1</CouponSeries>
<CouponSeriesName>sample string 1</CouponSeriesName>
<CouponStatus>64</CouponStatus>
<CouponStatusName>sample string 3</CouponStatusName>
<Id>1</Id>
<NoFree>true</NoFree>
</CouponRespDataRow>
<CouponRespDataRow>
<Client>1</Client>
<CountUsed>1</CountUsed>
<Coupon>sample string 2</Coupon>
<CouponId>1</CouponId>
<CouponSeries>1</CouponSeries>
<CouponSeriesName>sample string 1</CouponSeriesName>
<CouponStatus>64</CouponStatus>
<CouponStatusName>sample string 3</CouponStatusName>
<Id>1</Id>
<NoFree>true</NoFree>
</CouponRespDataRow>
</Data>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</PagingInfoResponse>