POST api/site/GetCampaigns

Получение списка акций

Request Information

URI Parameters

None.

Body Parameters

GetCampaignsRequest
NameDescriptionTypeAdditional information
Operator

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

integer

None.

PartnerID

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

integer

None.

IsMainpage

это главная страница?

boolean

None.

IsSidebar

это сайдбар?

boolean

None.

IsRecommended

это рекомендовано?

boolean

None.

IsNew

это новая?

boolean

None.

ClientID

идентификатор клиента

integer

None.

CityID

идентификатор города

integer

None.

SegmentID

идентификатор сегмента

integer

None.

CategoryID

идентификатор категории

integer

None.

FavClientCampaign

идентификатор клиента

integer

None.

Pos

код Торговой точки

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Operator": 1,
  "PartnerID": 2,
  "IsMainpage": true,
  "IsSidebar": true,
  "IsRecommended": true,
  "IsNew": true,
  "ClientID": 1,
  "CityID": 1,
  "SegmentID": 1,
  "CategoryID": 1,
  "FavClientCampaign": 1,
  "Pos": 1
}

application/xml, text/xml

Sample:
<GetCampaignsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <CategoryID>1</CategoryID>
  <CityID>1</CityID>
  <ClientID>1</ClientID>
  <FavClientCampaign>1</FavClientCampaign>
  <IsMainpage>true</IsMainpage>
  <IsNew>true</IsNew>
  <IsRecommended>true</IsRecommended>
  <IsSidebar>true</IsSidebar>
  <Operator>1</Operator>
  <PartnerID>2</PartnerID>
  <Pos>1</Pos>
  <SegmentID>1</SegmentID>
</GetCampaignsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetCampaignsResponse
NameDescriptionTypeAdditional information
ErrorCode

код ошибки

integer

None.

Message

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

string

None.

CampaignData

Список акций

Collection of Campaign

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 1,
  "Message": "sample string 2",
  "CampaignData": [
    {
      "id": 1,
      "name": "sample string 2",
      "logo": "sample string 3",
      "large": true,
      "partnerlogo": "sample string 5",
      "description": "sample string 6",
      "condition": "sample string 7",
      "tagline": "sample string 8",
      "isPopular": true,
      "isNew": true,
      "categoryId": [
        1,
        2
      ],
      "partnerId": 11,
      "internetShop": "sample string 12",
      "isFav": true,
      "share_url": "sample string 14",
      "startDate": "2024-04-19T17:33:08.7891619+03:00",
      "endDate": "2024-04-19T17:33:08.7891619+03:00",
      "active": true,
      "noposes": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "logo": "sample string 3",
      "large": true,
      "partnerlogo": "sample string 5",
      "description": "sample string 6",
      "condition": "sample string 7",
      "tagline": "sample string 8",
      "isPopular": true,
      "isNew": true,
      "categoryId": [
        1,
        2
      ],
      "partnerId": 11,
      "internetShop": "sample string 12",
      "isFav": true,
      "share_url": "sample string 14",
      "startDate": "2024-04-19T17:33:08.7891619+03:00",
      "endDate": "2024-04-19T17:33:08.7891619+03:00",
      "active": true,
      "noposes": true
    }
  ]
}

application/xml, text/xml

Sample:
<GetCampaignsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
  <CampaignData>
    <Campaign>
      <active>true</active>
      <categoryId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </categoryId>
      <condition>sample string 7</condition>
      <description>sample string 6</description>
      <endDate>2024-04-19T17:33:08.7891619+03:00</endDate>
      <id>1</id>
      <internetShop>sample string 12</internetShop>
      <isFav>true</isFav>
      <isNew>true</isNew>
      <isPopular>true</isPopular>
      <large>true</large>
      <logo>sample string 3</logo>
      <name>sample string 2</name>
      <noposes>true</noposes>
      <partnerId>11</partnerId>
      <partnerlogo>sample string 5</partnerlogo>
      <share_url>sample string 14</share_url>
      <startDate>2024-04-19T17:33:08.7891619+03:00</startDate>
      <tagline>sample string 8</tagline>
    </Campaign>
    <Campaign>
      <active>true</active>
      <categoryId xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </categoryId>
      <condition>sample string 7</condition>
      <description>sample string 6</description>
      <endDate>2024-04-19T17:33:08.7891619+03:00</endDate>
      <id>1</id>
      <internetShop>sample string 12</internetShop>
      <isFav>true</isFav>
      <isNew>true</isNew>
      <isPopular>true</isPopular>
      <large>true</large>
      <logo>sample string 3</logo>
      <name>sample string 2</name>
      <noposes>true</noposes>
      <partnerId>11</partnerId>
      <partnerlogo>sample string 5</partnerlogo>
      <share_url>sample string 14</share_url>
      <startDate>2024-04-19T17:33:08.7891619+03:00</startDate>
      <tagline>sample string 8</tagline>
    </Campaign>
  </CampaignData>
  <ErrorCode>1</ErrorCode>
  <Message>sample string 2</Message>
</GetCampaignsResponse>