POST api/coupon/SeriesPagingInfo

Получение информации о сериях купонов с входными фильтрами и пагинацией

Request Information

URI Parameters

None.

Body Parameters

CouponRequestSeriesPagingInfo
NameDescriptionTypeAdditional information
CouponSeries

Входной фильтр: идентификатор серии купонов

 integer

None.
Name

Входной фильтр: наименование серии купонов

 string

None.
Start

Фильтр: с какой позиции вернуть записи

 integer

None.
Length

Фильтр: какое количество записей вернуть

 integer

None.
Operator

Идентификатор оператора программы лояльности

 integer

None.
Token

Токен пользователя, который инициирует данный запрос

 integer

None.
SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CouponSeries": 1,
  "Name": "sample string 1",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample: 
<SeriesPagingInfoRequest 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>
  <CouponSeries>1</CouponSeries>
  <Length>1</Length>
  <Name>sample string 1</Name>
  <Start>1</Start>
</SeriesPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CouponResponsePagingInfo
NameDescriptionTypeAdditional information
TotalRows

Общее количество записей, которые можно вернуть после применения всех фильтров

 integer

None.
TotalRowsSelect

Общее количество записей, которые вернулись в конкретном запросе с пагинацией

 integer

None.
Data

Массив данных

 Collection of CouponSeriesDataRow

None.
ErrorCode

Код ошибки

 integer

None.
Message

Сообщение об ошибке

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "CouponSeriesId": 1,
      "CouponSeriesName": "sample string 1",
      "Campaign": 1,
      "CouponType": 64,
      "CouponTypeName": "sample string 2",
      "CouponForRedeem": true,
      "RedeemForCoupon": true,
      "AllowReuse": true,
      "NoActive": true,
      "DateCreate": "2025-12-22T09:28:30.7814284+03:00",
      "CountCoupons": 1
    },
    {
      "Id": 1,
      "CouponSeriesId": 1,
      "CouponSeriesName": "sample string 1",
      "Campaign": 1,
      "CouponType": 64,
      "CouponTypeName": "sample string 2",
      "CouponForRedeem": true,
      "RedeemForCoupon": true,
      "AllowReuse": true,
      "NoActive": true,
      "DateCreate": "2025-12-22T09:28:30.7814284+03:00",
      "CountCoupons": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<SeriesPagingInfoResponse 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>
    <CouponSeriesDataRow>
      <AllowReuse>true</AllowReuse>
      <Campaign>1</Campaign>
      <CountCoupons>1</CountCoupons>
      <CouponForRedeem>true</CouponForRedeem>
      <CouponSeriesId>1</CouponSeriesId>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponType>64</CouponType>
      <CouponTypeName>sample string 2</CouponTypeName>
      <DateCreate>2025-12-22T09:28:30.7814284+03:00</DateCreate>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <RedeemForCoupon>true</RedeemForCoupon>
    </CouponSeriesDataRow>
    <CouponSeriesDataRow>
      <AllowReuse>true</AllowReuse>
      <Campaign>1</Campaign>
      <CountCoupons>1</CountCoupons>
      <CouponForRedeem>true</CouponForRedeem>
      <CouponSeriesId>1</CouponSeriesId>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponType>64</CouponType>
      <CouponTypeName>sample string 2</CouponTypeName>
      <DateCreate>2025-12-22T09:28:30.7814284+03:00</DateCreate>
      <Id>1</Id>
      <NoActive>true</NoActive>
      <RedeemForCoupon>true</RedeemForCoupon>
    </CouponSeriesDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</SeriesPagingInfoResponse>