POST api/sertcard/SertCardInfo

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

Request Information

URI Parameters

None.

Body Parameters

SertCardInfoRequest
NameDescriptionTypeAdditional information
Sertcard

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<SertCardInfoRequest 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>
  <Sertcard>1</Sertcard>
</SertCardInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SertCardInfoResponse
NameDescriptionTypeAdditional information
Nominal

Номинал сертификата (изначальный баланс по сути)

decimal number

None.

Sertbalance

Остаток на балансе сертификата после использования

decimal number

None.

Sertcardtype

Тип сертификата

string

None.

Sertcardstatus

Статус сертификата

string

None.

Countused

Сколько раз использовался сертификат

integer

None.

Sertcardseries

Наименование серии в рамках которой выпущен сертификат

string

None.

Campaign

Идентификатор акции, в рамках которой выпущен и существует сертификат

integer

None.

Client

Идентификатор клиента, которому принадлежит сертификат

integer

None.

Allowrefund

Можно ли проводить возврат по сертификату

boolean

None.

Allowreuse

Можно ли переиспользовать после первого применения

boolean

None.

SecretCode

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

boolean

None.

SertImage

Ссылка на изображение сертификата

string

None.

SertCongratulation

Поздравление, которое было написано при покупке этого сертификата получателю сертификата

string

None.

SertExpDate

Дата сгорания (деактивации) сертификата

date

None.

PurchaseStatus

Стадия жизненного цикла сертификата (сгенерен => готовится к продаже => в продаже => продан => возвращён)

string

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Nominal": 1.0,
  "Sertbalance": 1.0,
  "Sertcardtype": "sample string 1",
  "Sertcardstatus": "sample string 2",
  "Countused": 1,
  "Sertcardseries": "sample string 3",
  "Campaign": 1,
  "Client": 1,
  "Allowrefund": true,
  "Allowreuse": true,
  "SecretCode": true,
  "SertImage": "sample string 4",
  "SertCongratulation": "sample string 5",
  "SertExpDate": "2022-08-14T14:58:23.8445833+03:00",
  "PurchaseStatus": "sample string 6",
  "ErrorCode": 7,
  "Message": "sample string 8"
}

application/xml, text/xml

Sample:
<SertCardInfoResponse 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">7</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 8</Message>
  <Allowrefund>true</Allowrefund>
  <Allowreuse>true</Allowreuse>
  <Campaign>1</Campaign>
  <Client>1</Client>
  <Countused>1</Countused>
  <Nominal>1</Nominal>
  <PurchaseStatus>sample string 6</PurchaseStatus>
  <SecretCode>true</SecretCode>
  <SertCongratulation>sample string 5</SertCongratulation>
  <SertExpDate>2022-08-14T14:58:23.8445833+03:00</SertExpDate>
  <SertImage>sample string 4</SertImage>
  <Sertbalance>1</Sertbalance>
  <Sertcardseries>sample string 3</Sertcardseries>
  <Sertcardstatus>sample string 2</Sertcardstatus>
  <Sertcardtype>sample string 1</Sertcardtype>
</SertCardInfoResponse>