POST api/site/GetCities
Получение списка городов
Request Information
URI Parameters
None.
Body Parameters
GetCitiesRequestName | Description | Type | Additional information |
---|---|---|---|
Partner |
Идентификатор партнера для фильтрации |
integer |
None. |
Region |
Идентификатор региона для фильтрации |
byte |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Partner": 1, "Region": 64, "Operator": 1, "Token": 1, "SiteCode": "sample string 1" }
application/xml, text/xml
Sample:
<GetCitiesRequest 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 1</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <Partner>1</Partner> <Region>64</Region> </GetCitiesRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetCitiesResponseName | Description | Type | Additional information |
---|---|---|---|
ErrorCode |
код ошибки |
integer |
None. |
Message |
сообщение об ошибке |
string |
None. |
CityData | Collection of City |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorCode": 1, "Message": "sample string 2", "CityData": [ { "id": 1, "name": "sample string 2", "region": "sample string 3" }, { "id": 1, "name": "sample string 2", "region": "sample string 3" } ] }
application/xml, text/xml
Sample:
<GetCitiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Models"> <CityData> <City> <id>1</id> <name>sample string 2</name> <region>sample string 3</region> </City> <City> <id>1</id> <name>sample string 2</name> <region>sample string 3</region> </City> </CityData> <ErrorCode>1</ErrorCode> <Message>sample string 2</Message> </GetCitiesResponse>