POST api/sertcard/SertCardIdentify

Проверка возможности использования подарочного сертификата у Оператора/Партнера/Точки/Клиента

Request Information

URI Parameters

None.

Body Parameters

SertCardIdentifyRequest
NameDescriptionTypeAdditional information
Client

Идентификатор клиента, для проверки, может ли клиент пользоваться данным сертификатом

integer

None.

SertCard

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

integer

None.

Partner

Идентификатор партнера

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Client": 1,
  "SertCard": 1,
  "Partner": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<SertCardIdentifyRequest 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>
  <Client>1</Client>
  <Partner>1</Partner>
  <SertCard>1</SertCard>
</SertCardIdentifyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SertCardIdentifyResponse
NameDescriptionTypeAdditional information
SertCardSeries

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

integer

None.

SertBalance

Остаток на балансе сертификата

decimal number

None.

AllowRefund

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

boolean

None.

CardNoLoyalty

На эту карту записываются чеки, если покупка идёт не участником ПЛ и нет карты лояльности на входе у ХП ChequeAdd

integer

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SertCardSeries": 1,
  "SertBalance": 1.0,
  "AllowRefund": true,
  "CardNoLoyalty": 1,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<SertCardIdentifyResponse 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>
  <AllowRefund>true</AllowRefund>
  <CardNoLoyalty>1</CardNoLoyalty>
  <SertBalance>1</SertBalance>
  <SertCardSeries>1</SertCardSeries>
</SertCardIdentifyResponse>