POST api/coupon/CouponAction

Создание/изменение/получение информации по купону/промокоду

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ActionType	Тип действия (Create, Update, Info)	string	None.
Coupon	Наименование купона/промокода	string	None.
CouponId	Идентификатор купона для изменения	integer	None.
CouponStatus	Статус купона	byte	None.
CouponType	Тип купона	byte	None.
CouponSeries	Идентификатор серии в рамках которой выпущен купон	integer	None.
Campaign	Идентификатор акции, в рамках которой выпущен и существует купон	integer	None.
Client	Идентификатор клиента, которому принадлежит купон	integer	None.
AllowReuse	Можно ли переиспользовать после первого применения	boolean	None.
NoFree	Признак занятости купона	boolean	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ActionType": "sample string 1",
  "Coupon": "sample string 2",
  "CouponId": 1,
  "CouponStatus": 64,
  "CouponType": 64,
  "CouponSeries": 1,
  "Campaign": 1,
  "Client": 1,
  "AllowReuse": true,
  "NoFree": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:

<CouponActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.CouponRequest">
  <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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 1</ActionType>
  <AllowReuse>true</AllowReuse>
  <Campaign>1</Campaign>
  <Client>1</Client>
  <Coupon>sample string 2</Coupon>
  <CouponId>1</CouponId>
  <CouponSeries>1</CouponSeries>
  <CouponStatus>64</CouponStatus>
  <CouponType>64</CouponType>
  <NoFree>true</NoFree>
</CouponActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CouponResponseCouponAction

Name	Description	Type	Additional information
Data	Массив данных	Collection of CouponRespDataRow	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "Id": 1,
      "CouponId": 1,
      "CouponSeries": 1,
      "CouponSeriesName": "sample string 1",
      "Coupon": "sample string 2",
      "NoFree": true,
      "CouponStatus": 64,
      "CouponStatusName": "sample string 3",
      "CountUsed": 1,
      "Client": 1
    },
    {
      "Id": 1,
      "CouponId": 1,
      "CouponSeries": 1,
      "CouponSeriesName": "sample string 1",
      "Coupon": "sample string 2",
      "NoFree": true,
      "CouponStatus": 64,
      "CouponStatusName": "sample string 3",
      "CountUsed": 1,
      "Client": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<CouponActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.CouponResponse">
  <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>
    <CouponRespDataRow>
      <Client>1</Client>
      <CountUsed>1</CountUsed>
      <Coupon>sample string 2</Coupon>
      <CouponId>1</CouponId>
      <CouponSeries>1</CouponSeries>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponStatus>64</CouponStatus>
      <CouponStatusName>sample string 3</CouponStatusName>
      <Id>1</Id>
      <NoFree>true</NoFree>
    </CouponRespDataRow>
    <CouponRespDataRow>
      <Client>1</Client>
      <CountUsed>1</CountUsed>
      <Coupon>sample string 2</Coupon>
      <CouponId>1</CouponId>
      <CouponSeries>1</CouponSeries>
      <CouponSeriesName>sample string 1</CouponSeriesName>
      <CouponStatus>64</CouponStatus>
      <CouponStatusName>sample string 3</CouponStatusName>
      <Id>1</Id>
      <NoFree>true</NoFree>
    </CouponRespDataRow>
  </Data>
</CouponActionResponse>