POST api/sertcard/SertcardGeneratePagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

SertCardGeneratePagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки

string

None.

Report

Признак, что запрашивается отчёт, а не данные для таблицы

boolean

None.

SertCardSeries

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

integer

None.

Nominal

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

decimal number

None.

GenerateId

Входной фильтр: идентификатор генерации

integer

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

Sample:
{
  "PosCode": "sample string 1",
  "Report": true,
  "SertCardSeries": 1,
  "Nominal": 1.0,
  "GenerateId": 1,
  "BegDate": "2024-06-20T05:39:59.9435031+03:00",
  "EndDate": "2024-06-20T05:39:59.9435031+03:00",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<SertCardGeneratePagingInfoRequest 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>
  <BegDate>2024-06-20T05:39:59.9435031+03:00</BegDate>
  <EndDate>2024-06-20T05:39:59.9435031+03:00</EndDate>
  <GenerateId>1</GenerateId>
  <Length>1</Length>
  <Nominal>1</Nominal>
  <PosCode>sample string 1</PosCode>
  <Report>true</Report>
  <SertCardSeries>1</SertCardSeries>
  <Start>1</Start>
</SertCardGeneratePagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SertCardGeneratePagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Общее кол-во строк, которое может вернуться в выборке

integer

None.

TotalRowsSelect

Общее кол-во строк, которое вернулось в запросе

integer

None.

Data

Информация о генерации сертификатов

Collection of SertCardGeneratePagingInfoDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "GenerateId": 1,
      "SertCardSeriesName": "sample string 1",
      "SertCardSeries": 1,
      "DateCreate": "2024-06-20T05:39:59.9591241+03:00",
      "Amount": 1,
      "Nominal": 1.0,
      "FirstNumber": 1,
      "LastNumber": 1,
      "CountNumber": 1,
      "PersonId": 1,
      "PersonName": "sample string 2"
    },
    {
      "Id": 1,
      "GenerateId": 1,
      "SertCardSeriesName": "sample string 1",
      "SertCardSeries": 1,
      "DateCreate": "2024-06-20T05:39:59.9591241+03:00",
      "Amount": 1,
      "Nominal": 1.0,
      "FirstNumber": 1,
      "LastNumber": 1,
      "CountNumber": 1,
      "PersonId": 1,
      "PersonName": "sample string 2"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<SertCardGeneratePagingInfoResponse 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>
    <SertCardGeneratePagingInfoResponse.SertCardGeneratePagingInfoDataRow>
      <Amount>1</Amount>
      <CountNumber>1</CountNumber>
      <DateCreate>2024-06-20T05:39:59.9591241+03:00</DateCreate>
      <FirstNumber>1</FirstNumber>
      <GenerateId>1</GenerateId>
      <Id>1</Id>
      <LastNumber>1</LastNumber>
      <Nominal>1</Nominal>
      <PersonId>1</PersonId>
      <PersonName>sample string 2</PersonName>
      <SertCardSeries>1</SertCardSeries>
      <SertCardSeriesName>sample string 1</SertCardSeriesName>
    </SertCardGeneratePagingInfoResponse.SertCardGeneratePagingInfoDataRow>
    <SertCardGeneratePagingInfoResponse.SertCardGeneratePagingInfoDataRow>
      <Amount>1</Amount>
      <CountNumber>1</CountNumber>
      <DateCreate>2024-06-20T05:39:59.9591241+03:00</DateCreate>
      <FirstNumber>1</FirstNumber>
      <GenerateId>1</GenerateId>
      <Id>1</Id>
      <LastNumber>1</LastNumber>
      <Nominal>1</Nominal>
      <PersonId>1</PersonId>
      <PersonName>sample string 2</PersonName>
      <SertCardSeries>1</SertCardSeries>
      <SertCardSeriesName>sample string 1</SertCardSeriesName>
    </SertCardGeneratePagingInfoResponse.SertCardGeneratePagingInfoDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</SertCardGeneratePagingInfoResponse>