Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

ru:pro:remoteapi:apiref:resource:update_route [05/12/2013 09:27]
zuve
ru:pro:remoteapi:apiref:resource:update_route [05/12/2013 13:53]
Строка 1: Строка 1:
-{{indexmenu_n>​60}} 
-====== Маршруты:​ создание,​ редактирование и удаление ====== 
  
-Для создания,​ редактирования и удаления маршрутов используется команда **resource/​update_route**:​ 
- 
-<code javascript>​ 
-svc=resource/​update_route&​params={"​itemId":<​long>,​ 
-   "​id":<​long>,​ 
-   "​callMode":<​text>,​ 
-   "​resourceId":<​long>,​ 
-   "​zoneId":<​long>,​ 
-   "​d":<​text>,​ 
-   "​n":<​text>,​ 
-   "​f":<​long>,​ 
-   "​at":<​long>​} 
-</​code>​ 
- 
-===== Параметры ===== 
- 
-^  Название ​ ^ Описание ^ 
-|  itemId ​ | ID ресурса | 
-|  id  | ID маршрута | 
-|  callMode ​ | режим: создание,​ редактирование,​ удаление (create, update, delete) | 
-|  **Параметры,​ обязательными только при создании и редактировании:​** ​ || 
-|  resourceId ​ | ID ресурса для геозоны | 
-|  zoneId ​ | ID геозоны типа линия, которая будет использоваться в качестве маршрута | 
-|  d  | описание | 
-|  n  | название | 
-|  f  | флаги маршрута (см. ниже) | 
-|  at  | время активации | 
- 
-//​Флаги маршрута://​ 
-^ Флаг ^ Описание ^ 
-| 0x1 | геозона определена по ссылке | 
-| 0x2 | удалять завершенные рейсы с временной шкалы | 
-| 0x8 | зарегистрировать как сообщение объекта | 
-| 0x10 | порядок прохождения точек: возможны пропуски | 
-| 0x20 | сгенерировать событие для объекта | 
-| 0x40 | порядок прохождения точек: произвольный | 
- 
-===== Возвращаемый результат ===== 
- 
-При создании и редактировании:​ 
-<code javascript>​ 
-[ 
- <​long>,​ /​* ID маршрута */ 
- { 
- "​i":<​long>,​ /​* ID маршрута */ 
- "​nm":<​text>,​ /​* название */ 
- "​de":<​text>,​ /​* описание */ 
- "​at":<​uint>,​ /​* время активации */ 
- "​fl":<​long>,​ /​* флаги маршрута (см. выше) */ 
- "​st":<​long>,​ /​* состояние маршрута (см. ниже) */ 
- "​pt":<​uint>,​ /​* индекс последней пройденной точки маршрута */ 
- "​tm":<​uint>,​ /​* время смены статуса */ 
- "​ri":<​long>,​ /​* ID ресурса */ 
- "​z":<​long>​ /​* ID геозоны */ 
- } 
-] 
-</​code>​ 
- 
-//​Флаги состояния маршрута://​ 
-^ Флаг ^ Описание ^ 
-| 0x01 | проверка статуса неактивна | 
-| 0x02 | пройдены все контрольные точки | 
-| 0x04 | прибытие в контрольную точку | 
-| 0x08 | отправление из контрольной точки | 
-| 0x10 | объект вышел за пределы геозоны,​ по которой строился маршрут | 
-| 0x20 | объект движется с опозданием | 
-| 0x40 | объект движется с опережением | 
-| 0x80 | проверка статуса запрещена | 
- 
-При удалении:​ 
-<code javascript>​ 
-[ 
- <​long>,​ /​* ID маршрута */ 
- null 
-] 
-</​code>​ 
- 
-===== Возможные ошибки ===== 
-^  Код ​ ^ Значение ^ 
-|  1  | недействительная сессия | 
-|  2  | неверное имя сервиса | 
-|  3  | неверный результат | 
-|  4  | неверный формат или значение параметров | 
-|  6  | - доступ запрещен\\ - не подключен сервис\\ - не существует геозоны с указанным ID\\ - не существует маршрута с указанным ID\\ - ошибка удаления маршрута | 
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2019 Gurtam