get_zone_data
Чтобы получить подробную информацию о геозонах, используйте метод resource/get_zone_data.
Конечная точка
svc=resource/get_zone_data¶ms={
"itemId": <long>,
"col": [<long>],
"flags": <uint>
}
Параметры
Обязателен только параметр itemId.
| Параметр | Описание |
|---|---|
itemId |
ID ресурса. |
col |
Массив ID геозон. Необязательный параметр. Если он не указан, метод возвращает все геозоны ресурса. Если указан пустой массив, метод возвращает пустой массив. ID геозон, которых нет в ресурсе, пропускаются без ошибки. |
flags |
Флаги, определяющие формат возвращаемого JSON (см. ниже). Необязательный параметр. Значение по умолчанию — 0x1C. Оно также используется, если указано значение 0 или значение, не являющееся беззнаковым целым числом (например, -1). |
Доступны следующие значения флагов:
| Значение | Описание |
|---|---|
0x01 |
Площадь. |
0x02 |
Периметр. |
0x04 |
Координаты центра и границ геозоны. |
0x08 |
Все точки. |
0x10 |
Основные свойства. |
Поля id, ct и mt возвращаются при любых флагах.
Ответ
При успешном выполнении запроса возвращается результат в следующем формате:
[ /* массив с данными о геозонах */
{
"n": "<text>", /* имя геозоны */
"d": "<text>", /* описание */
"id": <long>, /* ID геозоны в ресурсе/учетной записи */
"rid": <long>, /* ID ресурса/учетной записи */
"t": <byte>, /* тип: 1 (линия), 2 (полигон), 3 (круг) */
"w": <uint>, /* толщина линии или радиус круга (единицы см. ниже) */
"f": <uint>, /* флаги геозоны (см. ниже) */
"c": <uint>, /* цвет (ARGB) */
"tc": <uint>, /* цвет текста (RGB) */
"ts": <uint>, /* размер шрифта */
"min": <uint>, /* показать на карте, начиная от этого масштаба */
"max": <uint>, /* показать на карте до этого масштаба */
"i": <uint>, /* контрольная сумма изображения (CRC32); 4294967295, если у геозоны нет изображения */
"icon": "<text>", /* URI изображения геозоны; возвращается, только если у геозоны есть изображение */
"path": "<text>", /* короткий путь к иконке из библиотеки иконок; пустой, если у геозоны нет такой иконки */
"ar": <double>, /* площадь (единицы см. ниже) */
"pr": <double>, /* периметр (единицы см. ниже) */
"libId": <long>, /* ID библиотеки иконок (0 для библиотеки иконок по умолчанию) */
"jp": <JSON>, /* произвольный JSON; возвращается, только если он задан для геозоны */
"b": { /* границы */
"min_x": <double>, /* минимальная долгота */
"min_y": <double>, /* минимальная широта */
"max_x": <double>, /* максимальная долгота */
"max_y": <double>, /* максимальная широта */
"cen_x": <double>, /* долгота центра */
"cen_y": <double> /* широта центра */
},
"p": [ /* массив точек геозоны */
{
"x": <double>, /* долгота */
"y": <double>, /* широта */
"r": <uint> /* радиус (единицы см. ниже) */
},
...
],
"ct": <uint>, /* время создания */
"mt": <uint> /* время последнего изменения */
},
...
]
Единицы w, r, ar и pr зависят от системы измерений ресурса. Если это американская или имперская система, значения указываются в футах (w, r, pr) и квадратных футах (ar). В остальных случаях — в метрах и квадратных метрах.
Флаги геозоны (f):
| Значение | Описание |
|---|---|
0x2 |
Геозона начала рейса. Используется в отчетах, если геозоны начала и окончания рейсов не указаны в настройках таблицы. |
0x4 |
Геозона окончания рейса. Используется в отчетах, если геозоны начала и окончания рейсов не указаны в настройках таблицы. |
0x10 |
Устанавливается автоматически при сохранении геозоны. |
0x20 |
Показать форму. |
0x40 |
Не упрощать геозону. |
Если запрос выполнить не удалось, возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 7 | Элемент с указанным ID не существует или не является ресурсом, либо у пользователя нет права доступа Просмотр геозон на ресурс. |