POST api/pos/PosPagingInfo
Получение данных о точках продаж Оператора, с входными фильтрами и пагинацией
Request Information
URI Parameters
None.
Body Parameters
PosPagingInfoRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PosCode |
Код торговой точки пользователя |
string |
None. |
| Name |
Входной фильтр: наименование точки продаж |
string |
None. |
| City |
Входной фильтр: идентификатор города |
integer |
None. |
| NoShown |
Входной фильтр: вернуть неактивные точки продаж |
boolean |
None. |
| Showm |
Входной фильтр: вернуть активные точки продаж |
boolean |
None. |
| Partner |
Входной фильтр: идентификатор партнера |
integer |
None. |
| PosPickup |
Входной фильтр: вернуть точки, которые помечены как точки самовывоза заказов |
boolean |
None. |
| NoPosPickup |
Входной фильтр: вернуть точки, которые НЕ помечены как точки самовывоза заказов |
boolean |
None. |
| Start |
Пагинация: номер записи, от которой показывать записи, включая указанную |
integer |
None. |
| Length |
Пагинация: позиция от которой показывать записи, включая указанную |
integer |
None. |
| LlcIpCompany |
Входной фильтр: вернуть точки с заполненным наименованием юридического лица или ИП точки продаж |
boolean |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"PosCode": "sample string 1",
"Name": "sample string 2",
"City": 1,
"NoShown": true,
"Showm": true,
"Partner": 1,
"PosPickup": true,
"NoPosPickup": true,
"Start": 1,
"Length": 1,
"LlcIpCompany": true,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 3"
}
application/xml, text/xml
<PosPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request"> <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> <City>1</City> <Length>1</Length> <LlcIpCompany>true</LlcIpCompany> <Name>sample string 2</Name> <NoPosPickup>true</NoPosPickup> <NoShown>true</NoShown> <Partner>1</Partner> <PosCode>sample string 1</PosCode> <PosPickup>true</PosPickup> <Showm>true</Showm> <Start>1</Start> </PosPagingInfoRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PosPagingInfoResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRows |
Количество записей всего |
integer |
None. |
| TotalRowsSelect |
Количество записей в запросе |
integer |
None. |
| PosPaging |
Массив итоговых данных |
Collection of PosPagingInfoPosPagingRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"TotalRows": 1,
"TotalRowsSelect": 1,
"PosPaging": [
{
"Id": 1,
"PosId": 1,
"Name": "sample string 1",
"Code": "sample string 2",
"Partner": 1,
"PartnerName": "sample string 3",
"City": 1,
"CityName": "sample string 4",
"Address": "sample string 5",
"Shown": true,
"LlcIpCompany": "sample string 6"
},
{
"Id": 1,
"PosId": 1,
"Name": "sample string 1",
"Code": "sample string 2",
"Partner": 1,
"PartnerName": "sample string 3",
"City": 1,
"CityName": "sample string 4",
"Address": "sample string 5",
"Shown": true,
"LlcIpCompany": "sample string 6"
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<PosPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
<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>
<PosPaging>
<PosPagingInfoResponse.PosPagingInfoPosPagingRow>
<Address>sample string 5</Address>
<City>1</City>
<CityName>sample string 4</CityName>
<Code>sample string 2</Code>
<Id>1</Id>
<LlcIpCompany>sample string 6</LlcIpCompany>
<Name>sample string 1</Name>
<Partner>1</Partner>
<PartnerName>sample string 3</PartnerName>
<PosId>1</PosId>
<Shown>true</Shown>
</PosPagingInfoResponse.PosPagingInfoPosPagingRow>
<PosPagingInfoResponse.PosPagingInfoPosPagingRow>
<Address>sample string 5</Address>
<City>1</City>
<CityName>sample string 4</CityName>
<Code>sample string 2</Code>
<Id>1</Id>
<LlcIpCompany>sample string 6</LlcIpCompany>
<Name>sample string 1</Name>
<Partner>1</Partner>
<PartnerName>sample string 3</PartnerName>
<PosId>1</PosId>
<Shown>true</Shown>
</PosPagingInfoResponse.PosPagingInfoPosPagingRow>
</PosPaging>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</PosPagingInfoResponse>