POST api/sertcard/SertcardSeriesAction
Создание/изменение/получение информации по серии сертификатов
Request Information
URI Parameters
None.
Body Parameters
SertCardSeriesActionRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
ActionType |
Тип действия (Create, Update, Info) |
string |
None. |
SertCardSeriesId |
Идентификатор серии сертификатов для изменения или получения информации |
integer |
None. |
SeriesName |
Наименование серии сертификатов |
string |
None. |
SertCardType |
Идентификатор типа генерируемых сертификатов |
byte |
None. |
Campaign |
Идентификатор акции, к которой привязана генерируемая серия сертификатов |
integer |
None. |
AllowRefund |
Признак разрешён ли возврат средств на сертификат при возврате покупки, которой был оплачен сертификат |
boolean |
None. |
AllowRefundPurchase |
Признак разрешён ли возврат товара типа сертификат |
boolean |
None. |
AllowReuse |
Признак разрешено ли использование сертификата более одного раза или он блокируется после первого использования |
boolean |
None. |
ExpDays |
Количество дней, через которое, после активации сертификата он должен заблокироваться |
integer |
None. |
SertCardPrefix |
Префикс, с которым нужно сгенерить сертификаты |
integer |
None. |
Length |
Длинна номера (8 или 13) |
integer |
None. |
SecretConfirm |
Признак подтверждать списание средств с сертификата пинкодом или нет, в рамках этой серии |
boolean |
None. |
GenerateNumberType |
Тип генерации сертификатов |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "ActionType": "sample string 2", "SertCardSeriesId": 1, "SeriesName": "sample string 3", "SertCardType": 64, "Campaign": 1, "AllowRefund": true, "AllowRefundPurchase": true, "AllowReuse": true, "ExpDays": 1, "SertCardPrefix": 1, "Length": 1, "SecretConfirm": true, "GenerateNumberType": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 4" }
application/xml, text/xml
<SertCardSeriesActionRequest 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 4</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 2</ActionType> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <Campaign>1</Campaign> <ExpDays>1</ExpDays> <GenerateNumberType>64</GenerateNumberType> <Length>1</Length> <PosCode>sample string 1</PosCode> <SecretConfirm>true</SecretConfirm> <SeriesName>sample string 3</SeriesName> <SertCardPrefix>1</SertCardPrefix> <SertCardSeriesId>1</SertCardSeriesId> <SertCardType>64</SertCardType> </SertCardSeriesActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SertCardSeriesActionResponseName | Description | Type | Additional information |
---|---|---|---|
SertCardSeries |
Идентификатор созданной серии сертификатов |
integer |
None. |
Data |
Информация о сериях сертификатов |
Collection of SertCardSeriesActionDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "SertCardSeries": 1, "Data": [ { "Id": 1, "SertCardSeries": 1, "SertCardSeriesName": "sample string 1", "DateCreate": "2024-04-29T17:50:08.169131+03:00", "SertCardType": 64, "SertCardTypeName": "sample string 2", "AllowRefund": true, "AllowReuse": true, "AllowRefundPurchase": true, "NoActive": true, "BegDate": "2024-04-29T17:50:08.169131+03:00", "EndDate": "2024-04-29T17:50:08.169131+03:00", "ExpDays": 1, "Length": 64, "SertCardPrefix": 1, "CountNumber": 1, "PersonId": 1, "PersonName": "sample string 3", "GenerateNumberType": 64, "GenerateNumberTypeName": "sample string 4" }, { "Id": 1, "SertCardSeries": 1, "SertCardSeriesName": "sample string 1", "DateCreate": "2024-04-29T17:50:08.169131+03:00", "SertCardType": 64, "SertCardTypeName": "sample string 2", "AllowRefund": true, "AllowReuse": true, "AllowRefundPurchase": true, "NoActive": true, "BegDate": "2024-04-29T17:50:08.169131+03:00", "EndDate": "2024-04-29T17:50:08.169131+03:00", "ExpDays": 1, "Length": 64, "SertCardPrefix": 1, "CountNumber": 1, "PersonId": 1, "PersonName": "sample string 3", "GenerateNumberType": 64, "GenerateNumberTypeName": "sample string 4" } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<SertCardSeriesActionResponse 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> <SertCardSeriesActionResponse.SertCardSeriesActionDataRow> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <BegDate>2024-04-29T17:50:08.169131+03:00</BegDate> <CountNumber>1</CountNumber> <DateCreate>2024-04-29T17:50:08.169131+03:00</DateCreate> <EndDate>2024-04-29T17:50:08.169131+03:00</EndDate> <ExpDays>1</ExpDays> <GenerateNumberType>64</GenerateNumberType> <GenerateNumberTypeName>sample string 4</GenerateNumberTypeName> <Id>1</Id> <Length>64</Length> <NoActive>true</NoActive> <PersonId>1</PersonId> <PersonName>sample string 3</PersonName> <SertCardPrefix>1</SertCardPrefix> <SertCardSeries>1</SertCardSeries> <SertCardSeriesName>sample string 1</SertCardSeriesName> <SertCardType>64</SertCardType> <SertCardTypeName>sample string 2</SertCardTypeName> </SertCardSeriesActionResponse.SertCardSeriesActionDataRow> <SertCardSeriesActionResponse.SertCardSeriesActionDataRow> <AllowRefund>true</AllowRefund> <AllowRefundPurchase>true</AllowRefundPurchase> <AllowReuse>true</AllowReuse> <BegDate>2024-04-29T17:50:08.169131+03:00</BegDate> <CountNumber>1</CountNumber> <DateCreate>2024-04-29T17:50:08.169131+03:00</DateCreate> <EndDate>2024-04-29T17:50:08.169131+03:00</EndDate> <ExpDays>1</ExpDays> <GenerateNumberType>64</GenerateNumberType> <GenerateNumberTypeName>sample string 4</GenerateNumberTypeName> <Id>1</Id> <Length>64</Length> <NoActive>true</NoActive> <PersonId>1</PersonId> <PersonName>sample string 3</PersonName> <SertCardPrefix>1</SertCardPrefix> <SertCardSeries>1</SertCardSeries> <SertCardSeriesName>sample string 1</SertCardSeriesName> <SertCardType>64</SertCardType> <SertCardTypeName>sample string 2</SertCardTypeName> </SertCardSeriesActionResponse.SertCardSeriesActionDataRow> </Data> <SertCardSeries>1</SertCardSeries> </SertCardSeriesActionResponse>