POST api/marketing/CampaignPagingInfo
Получение информации о кампании, с пагинацией и входными фильтрами
Request Information
URI Parameters
None.
Body Parameters
CampaignPagingInfoRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CampaignType |
Фильтр: идентификатор типа акции (1 = Акция, 2 = Оффер) |
byte |
None. |
| Active |
Фильтр: активные кампании |
boolean |
None. |
| NoActive |
Фильтр: не активные кампании |
boolean |
None. |
| BegDate |
Фильтр: дата начала действия |
date |
None. |
| EndDate |
Фильтр: дата окончания действия |
date |
None. |
| MarketList |
Фильтр: маркетиновый список, которому отображается акция как доступная |
integer |
None. |
| Partner |
Фильтр: партнер, у которого действует акция |
integer |
None. |
| Pos |
Фильтр: точка продаж, в которой действует акция |
integer |
None. |
| PosList |
Фильтр: список точек продаж, в которых действует акция |
integer |
None. |
| New |
Фильтр: "кампания-новинка" |
boolean |
None. |
| Recommended |
Фильтр: "рекомендованная кампания" |
boolean |
None. |
| MainPage |
Фильтр: отображение на гл. странице/экране |
boolean |
None. |
| OfferType |
Фильтр: тип оффера (1 = промокод, 2 = промоссылка) |
byte |
None. |
| CampaignId |
Фильтр: идентификатор кампании |
integer |
None. |
| Start |
Последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.) |
integer |
None. |
| Length |
Количество записей, которые нужно вернуть |
integer |
None. |
| SortUpShown |
Фильтр: сортировка акций с уровнем отображения по возврастанию |
boolean |
None. |
| SortDownShown |
Фильтр: сортировка акций с уровнем отображения по убыванию |
boolean |
None. |
| Name |
Фильтр: наименование акции |
string |
None. |
| Title |
Фильтр: заголовок акции |
string |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"CampaignType": 64,
"Active": true,
"NoActive": true,
"BegDate": "2025-12-17T18:34:38.5764073+03:00",
"EndDate": "2025-12-17T18:34:38.5764073+03:00",
"MarketList": 1,
"Partner": 1,
"Pos": 1,
"PosList": 1,
"New": true,
"Recommended": true,
"MainPage": true,
"OfferType": 64,
"CampaignId": 1,
"Start": 1,
"Length": 1,
"SortUpShown": true,
"SortDownShown": true,
"Name": "sample string 1",
"Title": "sample string 2",
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 3"
}
application/xml, text/xml
<CampaignPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest"> <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> <Active>true</Active> <BegDate>2025-12-17T18:34:38.5764073+03:00</BegDate> <CampaignId>1</CampaignId> <CampaignType>64</CampaignType> <EndDate>2025-12-17T18:34:38.5764073+03:00</EndDate> <Length>1</Length> <MainPage>true</MainPage> <MarketList>1</MarketList> <Name>sample string 1</Name> <New>true</New> <NoActive>true</NoActive> <OfferType>64</OfferType> <Partner>1</Partner> <Pos>1</Pos> <PosList>1</PosList> <Recommended>true</Recommended> <SortDownShown>true</SortDownShown> <SortUpShown>true</SortUpShown> <Start>1</Start> <Title>sample string 2</Title> </CampaignPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CampaignPagingInfoResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRows |
Количество записей, которые попали в выборку |
integer |
None. |
| TotalRowsSelect |
Количество записей, которые вернулись в массиве ответа на запрос |
integer |
None. |
| Data |
Полученные данные |
Collection of CampaignPagingInfoData |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"TotalRows": 1,
"TotalRowsSelect": 1,
"Data": [
{
"Id": 1,
"Campaign": 1,
"Name": "sample string 1",
"Active": true,
"StartDate": "2025-12-17T18:34:38.6076532+03:00",
"EndDate": "2025-12-17T18:34:38.6076532+03:00",
"Description": "sample string 2",
"Logo": "sample string 3",
"BigLogo": "sample string 4",
"TagLine": "sample string 5",
"Condition": "sample string 6",
"CampaignType": 64,
"CampaignTypeName": "sample string 7",
"MarketList": 1,
"MarketListName": "sample string 8",
"Partner": 1,
"PartnerName": "sample string 9",
"Pos": 1,
"PosName": "sample string 10",
"PosList": 1,
"Caption": "sample string 11",
"NoPoses": true,
"New": true,
"Recommended": true,
"MainPage": true,
"OfferType": 64,
"OfferUrl": "sample string 12",
"Price": 1.0,
"OldPrice": 1.0,
"ExpireDaysBefore": 64,
"LevelShown": 64
},
{
"Id": 1,
"Campaign": 1,
"Name": "sample string 1",
"Active": true,
"StartDate": "2025-12-17T18:34:38.6076532+03:00",
"EndDate": "2025-12-17T18:34:38.6076532+03:00",
"Description": "sample string 2",
"Logo": "sample string 3",
"BigLogo": "sample string 4",
"TagLine": "sample string 5",
"Condition": "sample string 6",
"CampaignType": 64,
"CampaignTypeName": "sample string 7",
"MarketList": 1,
"MarketListName": "sample string 8",
"Partner": 1,
"PartnerName": "sample string 9",
"Pos": 1,
"PosName": "sample string 10",
"PosList": 1,
"Caption": "sample string 11",
"NoPoses": true,
"New": true,
"Recommended": true,
"MainPage": true,
"OfferType": 64,
"OfferUrl": "sample string 12",
"Price": 1.0,
"OldPrice": 1.0,
"ExpireDaysBefore": 64,
"LevelShown": 64
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<CampaignPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
<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>
<CampaignPagingInfoResponse.CampaignPagingInfoData>
<Active>true</Active>
<BigLogo>sample string 4</BigLogo>
<Campaign>1</Campaign>
<CampaignType>64</CampaignType>
<CampaignTypeName>sample string 7</CampaignTypeName>
<Caption>sample string 11</Caption>
<Condition>sample string 6</Condition>
<Description>sample string 2</Description>
<EndDate>2025-12-17T18:34:38.6076532+03:00</EndDate>
<ExpireDaysBefore>64</ExpireDaysBefore>
<Id>1</Id>
<LevelShown>64</LevelShown>
<Logo>sample string 3</Logo>
<MainPage>true</MainPage>
<MarketList>1</MarketList>
<MarketListName>sample string 8</MarketListName>
<Name>sample string 1</Name>
<New>true</New>
<NoPoses>true</NoPoses>
<OfferType>64</OfferType>
<OfferUrl>sample string 12</OfferUrl>
<OldPrice>1</OldPrice>
<Partner>1</Partner>
<PartnerName>sample string 9</PartnerName>
<Pos>1</Pos>
<PosList>1</PosList>
<PosName>sample string 10</PosName>
<Price>1</Price>
<Recommended>true</Recommended>
<StartDate>2025-12-17T18:34:38.6076532+03:00</StartDate>
<TagLine>sample string 5</TagLine>
</CampaignPagingInfoResponse.CampaignPagingInfoData>
<CampaignPagingInfoResponse.CampaignPagingInfoData>
<Active>true</Active>
<BigLogo>sample string 4</BigLogo>
<Campaign>1</Campaign>
<CampaignType>64</CampaignType>
<CampaignTypeName>sample string 7</CampaignTypeName>
<Caption>sample string 11</Caption>
<Condition>sample string 6</Condition>
<Description>sample string 2</Description>
<EndDate>2025-12-17T18:34:38.6076532+03:00</EndDate>
<ExpireDaysBefore>64</ExpireDaysBefore>
<Id>1</Id>
<LevelShown>64</LevelShown>
<Logo>sample string 3</Logo>
<MainPage>true</MainPage>
<MarketList>1</MarketList>
<MarketListName>sample string 8</MarketListName>
<Name>sample string 1</Name>
<New>true</New>
<NoPoses>true</NoPoses>
<OfferType>64</OfferType>
<OfferUrl>sample string 12</OfferUrl>
<OldPrice>1</OldPrice>
<Partner>1</Partner>
<PartnerName>sample string 9</PartnerName>
<Pos>1</Pos>
<PosList>1</PosList>
<PosName>sample string 10</PosName>
<Price>1</Price>
<Recommended>true</Recommended>
<StartDate>2025-12-17T18:34:38.6076532+03:00</StartDate>
<TagLine>sample string 5</TagLine>
</CampaignPagingInfoResponse.CampaignPagingInfoData>
</Data>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</CampaignPagingInfoResponse>