Справочный центр Wialon

update_tag

Чтобы создать, изменить или удалить метки, используйте метод resource/update_tag. Метки используются при назначении или снятии пассажиров.

Конечная точка

Copied!
svc=resource/update_tag&params={
  "itemId": <long>,
  "id": <long>,
  "callMode": <text>,
  "n": <text>,
  "c": <text>,
  "tz": <int>,
  "f": <int>,
  "art": <uint>,
  "jp": {
    <text>: <text>,
    ...
  }
}

Параметры

Запрос должен содержать следующие параметры:

Параметр Описание
itemId ID ресурса.
id ID метки. Для создания метки отправьте 0.
callMode Тип действия: create, update, delete, reset_image (удаление изображения метки).
n Имя метки. Обязательно только для типов действия create и update.
c Код метки. Обязателен только для типов действия create и update.
tz Временнáя зона. Необязательно. Если параметр не указан, устанавливается временнáя зона создателя ресурса.
f Флаги. Необязательно. По умолчанию 0.
art Время для автоматического снятия. Необязательно. По умолчанию 36000 (10 часов).
jp Произвольные поля в формате "имя":"значение". Необязательно. Если параметр не указан, произвольные поля очищаются.

Ответ

При успешном выполнении запроса на создание или изменение метки либо на удаление ее изображения возвращается результат в следующем формате:

Copied!
[
  <long>,               /* ID метки. */
  {
    "id": <long>,       /* ID метки. */
    "n": <text>,        /* Имя. */
    "c": <text>,        /* Код. */
    "jp": {             /* Произвольные поля. */
      <text>: <text>,   /* Имя: значение. */
      ...
    },
    "r": <double>,      /* Пропорции изображения. */
    "ck": <ushort>,     /* Контрольная сумма изображения. */
    "f": <ushort>,      /* Флаги, в настоящее время не используются. По умолчанию 1. */
    "bu": <long>,       /* Назначенный объект. */
    "pu": <long>,       /* Предыдущий назначенный объект. */
    "bt": <uint>,       /* Время последнего назначения/снятия. */
    "tz": <int>,        /* Временнáя зона. */
    "art": <uint>,      /* Время для автоматического снятия. */
    "pos": {            /* Местоположение. */
      "y": <double>,    /* Широта. */
      "x": <double>     /* Долгота. */
    },
    "ct": <uint>,       /* Время создания (формат Unix). */
    "mt": <uint>        /* Время последнего изменения (формат Unix). */
  }
]

При успешном выполнении запроса на удаление метки возвращается результат в следующем формате:

Copied!
[
  <long>,  /* ID метки. */
  null
]

Если запрос выполнить не удалось, возвращается код ошибки.

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры. Для типа действия update эта ошибка также возвращается, если метка с указанным ID не существует.
6 Неопределенная ошибка. Для типов действия delete и reset_image эта ошибка также возвращается, если метка с указанным ID не существует.
7 Ресурс не существует, или у пользователя нет права доступа Создание, редактирование и удаление пассажиров к нему.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.