POST api/client/GetPartners
Возвращает информацию о Партнере
Request Information
URI Parameters
None.
Body Parameters
GetPartnersRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IsMainPage |
Главная страница? |
boolean |
None. |
| CityID |
ID города |
integer |
None. |
| SegmentID |
ID сегмента |
integer |
None. |
| CategoryID |
ID категории |
integer |
None. |
| IsCardIssue |
Есть карты? |
boolean |
None. |
| IsInCity |
Есть ТТ в городе? |
boolean |
None. |
| IsInInternet |
Есть интеренет магазин? |
boolean |
None. |
| ClientID |
идентификатор клиента |
integer |
None. |
| Questionnaire |
фильтр: идентификатор опроса, для которого запрашивается список партнёров |
integer |
None. |
| AboutUsShown |
Фильтр: партнер, который является тем, кто организовал ПЛ, чтобы в разделе "о нас" была только его плитка |
boolean |
None. |
| SortUpShown |
Фильтр: сортировка партнеров с уровнем отображения по возврастанию |
boolean |
None. |
| SortDownShown |
Фильтр: сортировка партнеров с уровнем отображения по убыванию |
boolean |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"IsMainPage": true,
"CityID": 2,
"SegmentID": 3,
"CategoryID": 4,
"IsCardIssue": true,
"IsInCity": true,
"IsInInternet": true,
"ClientID": 1,
"Questionnaire": 1,
"AboutUsShown": true,
"SortUpShown": true,
"SortDownShown": true,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 8"
}
application/xml, text/xml
Sample:
<GetPartnersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models"> <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 8</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <AboutUsShown>true</AboutUsShown> <CategoryID>4</CategoryID> <CityID>2</CityID> <ClientID>1</ClientID> <IsCardIssue>true</IsCardIssue> <IsInCity>true</IsInCity> <IsInInternet>true</IsInInternet> <IsMainPage>true</IsMainPage> <Questionnaire>1</Questionnaire> <SegmentID>3</SegmentID> <SortDownShown>true</SortDownShown> <SortUpShown>true</SortUpShown> </GetPartnersRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetPartnersResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
код ошибки |
integer |
None. |
| Message |
сообщение об ошибке |
string |
None. |
| PartnerData |
список партнеров с детализацией |
Collection of Partner |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorCode": 1,
"Message": "sample string 2",
"PartnerData": [
{
"id": 1,
"name": "sample string 2",
"logo": "sample string 3",
"description": "sample string 4",
"condition": "sample string 5",
"tagline": "sample string 6",
"internetshop": "sample string 7",
"isCardIssue": true,
"isInCity": true,
"isInInternet": true,
"isFav": true,
"share_url": "sample string 12",
"biglogo": "sample string 13",
"showOnSite": true,
"addressInMobile": true,
"internetshopButtonName": "sample string 16",
"aboutUsShown": true,
"levelShown": 64,
"Category": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
],
"City": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
],
"Segment": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
]
},
{
"id": 1,
"name": "sample string 2",
"logo": "sample string 3",
"description": "sample string 4",
"condition": "sample string 5",
"tagline": "sample string 6",
"internetshop": "sample string 7",
"isCardIssue": true,
"isInCity": true,
"isInInternet": true,
"isFav": true,
"share_url": "sample string 12",
"biglogo": "sample string 13",
"showOnSite": true,
"addressInMobile": true,
"internetshopButtonName": "sample string 16",
"aboutUsShown": true,
"levelShown": 64,
"Category": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
],
"City": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
],
"Segment": [
{
"Id": 1,
"Name": "sample string 1"
},
{
"Id": 1,
"Name": "sample string 1"
}
]
}
]
}
application/xml, text/xml
Sample:
<GetPartnersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models">
<ErrorCode>1</ErrorCode>
<Message>sample string 2</Message>
<PartnerData>
<Partner>
<Category>
<Partner.PdCategory>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCategory>
<Partner.PdCategory>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCategory>
</Category>
<City>
<Partner.PdCity>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCity>
<Partner.PdCity>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCity>
</City>
<Segment>
<Partner.PdSegment>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdSegment>
<Partner.PdSegment>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdSegment>
</Segment>
<aboutUsShown>true</aboutUsShown>
<addressInMobile>true</addressInMobile>
<biglogo>sample string 13</biglogo>
<condition>sample string 5</condition>
<description>sample string 4</description>
<id>1</id>
<internetshop>sample string 7</internetshop>
<internetshopButtonName>sample string 16</internetshopButtonName>
<isCardIssue>true</isCardIssue>
<isFav>true</isFav>
<isInCity>true</isInCity>
<isInInternet>true</isInInternet>
<levelShown>64</levelShown>
<logo>sample string 3</logo>
<name>sample string 2</name>
<share_url>sample string 12</share_url>
<showOnSite>true</showOnSite>
<tagline>sample string 6</tagline>
</Partner>
<Partner>
<Category>
<Partner.PdCategory>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCategory>
<Partner.PdCategory>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCategory>
</Category>
<City>
<Partner.PdCity>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCity>
<Partner.PdCity>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdCity>
</City>
<Segment>
<Partner.PdSegment>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdSegment>
<Partner.PdSegment>
<Id>1</Id>
<Name>sample string 1</Name>
</Partner.PdSegment>
</Segment>
<aboutUsShown>true</aboutUsShown>
<addressInMobile>true</addressInMobile>
<biglogo>sample string 13</biglogo>
<condition>sample string 5</condition>
<description>sample string 4</description>
<id>1</id>
<internetshop>sample string 7</internetshop>
<internetshopButtonName>sample string 16</internetshopButtonName>
<isCardIssue>true</isCardIssue>
<isFav>true</isFav>
<isInCity>true</isInCity>
<isInInternet>true</isInInternet>
<levelShown>64</levelShown>
<logo>sample string 3</logo>
<name>sample string 2</name>
<share_url>sample string 12</share_url>
<showOnSite>true</showOnSite>
<tagline>sample string 6</tagline>
</Partner>
</PartnerData>
</GetPartnersResponse>