Методы

Для работы по API v2.5 используйте следующие методы

object_add - добавление объекта

параметры:

  • track_id - идентификатор объекта, например, номер вагона, контейнера или морского судна
  • title - название (любое, понятное логисту)
  • timestamp_off - время автоматического отключения от мониторинга

В ответе будет возвращён object_id по которому можно будет обращаться в данному объекту

Пример успешного ответа:

{ "status": "NULL", "error_code": 0, "error_message": "NULL", "data": { "object_id": 0 } }

object_list - список ранее добавленных объектов

Без параметров

Возвращает массив объектов

  • object_id - ID отлеживаемого объекта в пределах Мовизора
  • uid - ID кабинета к которому подключен объект
  • urn - URN (Uniform Resource Name) пример urn:rails1:60826039
  • 'status' — [ok, error, wait, off, deleted … ]
  • title - название определённое в пределах личного кабинета (удобное для логиста)
  • timestamp_add — время постановки на мониторинг
  • timestamp_off — время автоматического снятия с мониторинга (если установлено пользователем)
  • timestamp_request — время последней попытки определения местоположения
  • timestamp_was_off — время фактического снятия с мониторинга
  • disabled — получение данных по объекту невозможно
  • is_offline — как минимум последняя попытка получить данные по объекту закончилась неудачно
  • at_request — последний запрос на получение данных ещё не обработан
  • first_position — объект Position описывающий пункт отправления
  • position — объект Position описывающий текущее местоположение
  • last_position — объект Position описывающий пункт назначения
  • actions — массив событий по отслеживаемому объекту. Один элемент массива - одно событие. **

Пример поля "data" в ответе:

{"object_id":13000004711,"uid":70109055,"urn":"urn:rails1:60826039","status":"ok","title":"","timestamp_add":1615549321,"timestamp_off":1893456000,"timestamp_request":1634500820,"timestamp_was_off":null,"disabled":0,"is_offline":false,"at_request":false,"first_position":{"locode":"782204","title":"","lat":56.406104601301,"lon":59.2488300663,"timestamp":1621427220,"status":"ok","type":"land","reverse_geocoding_title":"","reverse_geocoding":null,"route_pin_before":null},"position":{"locode":"782204","title":"","pos_timestamp":null,"timestamp":1621427220,"lat":56.406104601301,"lon":59.2488300663,"status":"ok","type":"land","reverse_geocoding_title":"","reverse_geocoding":null},"last_position":{"locode":"253508","title":"","lat":56.077002843848,"lon":49.88857013585,"timestamp":1621772820,"status":"ok","type":"land","reverse_geocoding_title":"","reverse_geocoding":null,"route_pin_after":null},"actions":[{"place":"","lat":56.40611,"lon":59.248911,"title":"","timestamp":1621427220,"status":"ok","type":"land","train_num":3522,"is_intrain":true,"position_in_train":14},{"place":"","lat":56.406104601301,"lon":59.2488300663,"title":"","timestamp":1621427220,"status":"ok","type":"land","train_num":3522,"is_intrain":true,"position_in_train":14}]}}

object_delete - cнятие с мониторинга

параметры:

  • object_id — идентификатор объекта полученный при добавлении объекта

Пример успешного ответа:

{ "status": "ok", "error_code": "NULL", "error_message": "NULL", "data": { "object_id": 21000000000 } }

object_get - получение информации об одном объекте

параметры:

  • object_id — идентификатор объекта полученный при добавлении объекта

object_edit - редактироване параметров объекта

параметры:

  • object_id - идентификатор объекта полученный при добавлении объекта
  • title - название (любое, понятное логисту)
  • timestamp_off - время автоматического отключения от мониторинга

В ответе будет возвращён object_id по которому можно будет обращаться в данному объекту

Пример успешного ответа:

{ "status": "NULL", "error_code": 0, "error_message": "NULL", "data": { "object_id": 0 } }

object_list_pos - список объектов с последними известными (текущими) координатами

без параметров:

Пример поля "data" в ответе:

{ "status": "ok", "error_code": "NULL", "error_message": "NULL", "data": [ { "object_id": 21000000000, "uid": 0, "urn": "urn:containers2:00000000", "pos_timestamp": 0, "pos_lat": 0, "pos_lon": 0 } ] }

object_pos_list - список координат одного объекта

параметры:

  • object_id — идентификатор объекта полученный при добавлении объекта

В ответе массив координат объекта. Пример:

"data": [ { "object_id": 21000000000, "urn": "urn:containers2:00000000", "pos_timestamp": 0, "pos_lat": 0, "pos_lon": 0 } ]

object_pos - последняя координата одного объекта

параметры:

  • object_id — идентификатор объекта полученный при добавлении объекта

В ответе последняя известная координата (от успешной попытки её получить). Пример:

"data": { "pos_timestamp": 0, "pos_lat": 0, "pos_lon": 0 }