POST api/sertcard/SeriesInfo

Получение информации о серии сертификатов

Request Information

URI Parameters

None.

Body Parameters

SeriesInfoRequest
NameDescriptionTypeAdditional information
SertCardSeries

Идентификатор серии сертификатов

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SertCardSeries": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<SeriesInfoRequest 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 1</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <SertCardSeries>1</SertCardSeries>
</SeriesInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SeriesInfoResponse
NameDescriptionTypeAdditional information
Active

Признак активности серии

boolean

None.

DateCreate

Дата создания серии

date

None.

SeriesName

Наименование серии сертификатов

string

None.

SertCardType

Наименование типа сертификатов серии

string

None.

Campaign

наименование акции, к которой привязана серия сертификатов

string

None.

AllowRefund

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

boolean

None.

AllowReuse

Признак разрешено ли использование сертификата более одного раза или он блокируется после первого использования

boolean

None.

ExpDays

Количество дней, через которое, после активации сертификата он должен заблокироваться

integer

None.

SecretConfirm

Признак подтверждать списание средств с сертификата пинкодом или нет, в рамках этой серии

boolean

None.

SertCardPrefix

Префикс, с которым нужно сгенерить сертификаты

integer

None.

Length

Длинна номера (8 или 13)

integer

None.

AllSertCards

Общее количество сертификатов этой серии, которое было сгенерено

integer

None.

AllGenerates

Общее количество генераций сертификатов в данной серии

integer

None.

User

Идентификатор юзера, который создал данную серию

integer

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Active": true,
  "DateCreate": "2022-08-14T15:51:09.922273+03:00",
  "SeriesName": "sample string 1",
  "SertCardType": "sample string 2",
  "Campaign": "sample string 3",
  "AllowRefund": true,
  "AllowReuse": true,
  "ExpDays": 1,
  "SecretConfirm": true,
  "SertCardPrefix": 1,
  "Length": 1,
  "AllSertCards": 1,
  "AllGenerates": 1,
  "User": 1,
  "ErrorCode": 4,
  "Message": "sample string 5"
}

application/xml, text/xml

Sample:
<SeriesInfoResponse 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">4</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 5</Message>
  <Active>true</Active>
  <AllGenerates>1</AllGenerates>
  <AllSertCards>1</AllSertCards>
  <AllowRefund>true</AllowRefund>
  <AllowReuse>true</AllowReuse>
  <Campaign>sample string 3</Campaign>
  <DateCreate>2022-08-14T15:51:09.922273+03:00</DateCreate>
  <ExpDays>1</ExpDays>
  <Length>1</Length>
  <SecretConfirm>true</SecretConfirm>
  <SeriesName>sample string 1</SeriesName>
  <SertCardPrefix>1</SertCardPrefix>
  <SertCardType>sample string 2</SertCardType>
  <User>1</User>
</SeriesInfoResponse>