API address

Раздел API ERP "UserSide"

Назначение: Действие с адресами

Дополнительные параметры:
action - подкатегория запроса (возможное значение: см.ниже)

Подкатегории

add_province

Описание: Добавление области
Обязательные параметры:
 name - Наименование
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленной области в случае успеха
 )

add_city

Описание: Добавление населенного пункта
Обязательные параметры:
 name - Наименование населенного пункта
Необязательные параметры:
 province_id - ID области
 district_id - ID района в области
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленного населенного пункта в случае успеха
 )

add_area

Описание: Добавление района в населённом пункте
Обязательные параметры:
 city_id - ID населенного пункта
 name - Наименование
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленного района в случае успеха
 )

add_street

Описание: Добавление улицы
Обязательные параметры:
 city_id - ID населенного пункта
 name - Наименование
Необязательные параметры:
 area_id - ID района населенного пункта
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленной улицы в случае успеха
 )

add_house

Описание: Добавление дома
Обязательные параметры:
 city_id - ID населенного пункта
 street_id - ID улицы
 number - Цифровой номер дома
 block - Блок/корпус дома
 custom_name - Произвольное (полное) наименование дома
Необязательные параметры:
 area_id - ID района в населенному пункте
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленного дома в случае успеха
 )

get_province

Описание: Список областей
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

get_city

Описание: Список населённых пунктов
Необязательные параметры:
 province_id - ID областей (можно через запятую)
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

get_area

Описание: Список районов населённых пунктов
Необязательные параметры:
 city_id - ID городов (можно через запятую)
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

get_street

Описание: Список улиц
Необязательные параметры:
 city_id - ID населённых пунктов (можно через запятую)
Необязательные параметры:
 area_id - ID районов населенных пунктов (можно через запятую)
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

get_house

Описание: Список домов
Необязательные параметры:
 id - перечень ID домов (через запятую)
 city_id - ID населённых пунктов (можно через запятую)
 area_id - ID районов населённых пунктов (можно через запятую)
 street_id - ID улиц (можно через запятую)
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

edit_house

Описание: Редактирование дома
Обязательные параметры:
 id - ID дома
Необязательные параметры:
 Перечень параметров используется аналогично методу add_house

add_house_mark

Описание: Добавление метки на доме
Обязательные параметры:
 house_id - ID дома
 mark_id - ID метки

delete_house_mark

Описание: Снятие метки с дома
Обязательные параметры:
 house_id - ID дома
 mark_id - ID метки