POST api/system/CityListAction
Создание/изменение/получение информации о списках городов проживания клиентов
Request Information
URI Parameters
None.
Body Parameters
CityListActionRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Наименование списка городов (для Create и Update) |
string |
None. |
| ActionType |
Тип действия, которое необходимо произвести (Create, Update, Info, Delete) |
string |
None. |
| CityListId |
Идентификатор списка который будут менять или в котором будут произодить изменения (для Update, Delete, Info) |
integer |
None. |
| Detail |
Признак, что нужно вернуть селект с детализацией по городам |
boolean |
None. |
| City |
Входной фильтр: идентификатор города в списке точек (для Info c detail = 1) |
integer |
None. |
| CityName |
Входной фильтр: наименование города (для Info c detail = 1) |
string |
None. |
| Region |
Входной фильтр: регион (для Info c detail = 1) |
integer |
None. |
| RegionName |
Входной фильтр: наименование региона (для Info c detail = 1) |
string |
None. |
| Start |
Пагинация: от какой записи возвращать данные, включая указанную (для Info c detail = 1) |
integer |
None. |
| Length |
Пагинация: количество записей, которые нужно вернуть (для Info c detail = 1) |
integer |
None. |
| Tag |
Тег списка (для Create и Update) |
string |
None. |
| CityRegion |
Массив идентификаторов (регионы, города) |
Collection of CityListActionCityRegionRow |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"Name": "sample string 1",
"ActionType": "sample string 2",
"CityListId": 1,
"Detail": true,
"City": 1,
"CityName": "sample string 3",
"Region": 1,
"RegionName": "sample string 4",
"Start": 1,
"Length": 1,
"Tag": "sample string 5",
"CityRegion": [
{
"Id": 1,
"City": 1,
"Region": 1
},
{
"Id": 1,
"City": 1,
"Region": 1
}
],
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 6"
}
application/xml, text/xml
<CityListActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest">
<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 6</SiteCode>
<Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
<ActionType>sample string 2</ActionType>
<City>1</City>
<CityListId>1</CityListId>
<CityName>sample string 3</CityName>
<CityRegion>
<CityListActionRequest.CityListActionCityRegionRow>
<City>1</City>
<Id>1</Id>
<Region>1</Region>
</CityListActionRequest.CityListActionCityRegionRow>
<CityListActionRequest.CityListActionCityRegionRow>
<City>1</City>
<Id>1</Id>
<Region>1</Region>
</CityListActionRequest.CityListActionCityRegionRow>
</CityRegion>
<Detail>true</Detail>
<Length>1</Length>
<Name>sample string 1</Name>
<Region>1</Region>
<RegionName>sample string 4</RegionName>
<Start>1</Start>
<Tag>sample string 5</Tag>
</CityListActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CityListActionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CityList |
Идентификатор созданного списка городов (для Create) |
integer |
None. |
| CountCity |
Количество городов в списке |
integer |
None. |
| ListName |
Наименование списка городов (для Info) |
string |
None. |
| ProcTime |
Дата и время создания списка (для Info) |
date |
None. |
| TotalRows |
Количество записей всего (для Info c detail = 1) |
integer |
None. |
| TotalRowsSelect |
Количество записей в запросе (для Info c detail = 1) |
integer |
None. |
| TagName |
Текущий тег списка |
string |
None. |
| City | Collection of CityListActionCityRow |
None. |
|
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"CityList": 1,
"CountCity": 1,
"ListName": "sample string 1",
"ProcTime": "2026-05-07T11:27:36.5986902+03:00",
"TotalRows": 1,
"TotalRowsSelect": 1,
"TagName": "sample string 2",
"City": [
{
"Id": 1,
"City": 1,
"CityName": "sample string 1",
"Region": 1,
"RegionName": "sample string 2"
},
{
"Id": 1,
"City": 1,
"CityName": "sample string 1",
"Region": 1,
"RegionName": "sample string 2"
}
],
"ErrorCode": 3,
"Message": "sample string 4"
}
application/xml, text/xml
<CityListActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse">
<ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">3</ErrorCode>
<Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</Message>
<City>
<CityListActionResponse.CityListActionCityRow>
<City>1</City>
<CityName>sample string 1</CityName>
<Id>1</Id>
<Region>1</Region>
<RegionName>sample string 2</RegionName>
</CityListActionResponse.CityListActionCityRow>
<CityListActionResponse.CityListActionCityRow>
<City>1</City>
<CityName>sample string 1</CityName>
<Id>1</Id>
<Region>1</Region>
<RegionName>sample string 2</RegionName>
</CityListActionResponse.CityListActionCityRow>
</City>
<CityList>1</CityList>
<CountCity>1</CountCity>
<ListName>sample string 1</ListName>
<ProcTime>2026-05-07T11:27:36.5986902+03:00</ProcTime>
<TagName>sample string 2</TagName>
<TotalRows>1</TotalRows>
<TotalRowsSelect>1</TotalRowsSelect>
</CityListActionResponse>