Спасибо!

Мы исправим ошибку в ближайшее время

Сообщить об ошибке

Инструменты сайта


Описание

Список методов SOAP

Для передачи даты и времени во всех сервисах используется формат UNIXTIME (в секундах), единицы измерения остальных параметров – согласно указанному.

signIn – авторизация

Входные значения
String login – логин пользователя в системе
String password – пароль пользователя в системе
Возвращаемые значения
Boolean status – true/false true в случае успешной авторизации
String sessionId – в случае успешной авторизации, идентификатор сессии (не менее 16 символов)
Unixtimestamp dateTimeEnd – в случае успешной авторизации время завершения сессии (время, после которого необходимо авторизоваться заново)
String error – текст ошибки в случае неправильной авторизации (неправильно введены логин и пароль либо неверный формат данных)

getObjectSet – список объектов

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Возвращаемые значения
Boolean status – true/false true в случае успешной операции. String error – текст сообщения об ошибке в случае возникновения ошибки
Dataset objects – список ТС, доступных пользователю, на которого зарегистрирована сессия (имеется в виду только те объекты право на просмотр которых имеет пользователь):
Integer id – идентификатор объекта (совпадает с идентификатором регистратора)
String objectName – название ТС
String objectType – тип ТС
String GarageNumber – гаражный номер

getSmoothedFuel – сглаженный уровень топлива за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status – true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Dataset fuel – набор данных (возвращаются все данные из хранилища за выбранный период):
Unixtimestamp timeStamp – время, на которое зафиксирован уровень топлива
Double smothedFuel – сглаженное значение уровня топлива, литров, точность до 0.1 литра
String error – текст сообщения, в случае возникновения ошибки

getFuelConsumption – расход топлива за период

Входные значения
String sessionId - идентификатор сессии, полученный во время авторизации
Integer objectId - идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) - время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции.
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double fuelConsumption – расход топлива за период, литры, точность до 0.1 литра
String error – текст сообщения об ошибке в случае возникновения ошибки

getEvents – список событий

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор ТС. Необязательный параметр, если идентификатора нет, то возвращаются данные для всех ТС.
Integer type – тип события, обязательный.
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) - время окончания интервала
Возвращаемые значения
Boolean status – true/false true в случае успешной операции.
String error - текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Dataset objectEvents – набор данных по каждому событию:
Unixtimestamp timeStamp – дата время события
Integer objectId – идентификатор ТС
String type – тип события
String parameters – параметры события
String eventAddress – адрес события, если есть
String iButton – номер iButton в HEX. Только для событий типа «Водитель»
String name – название геозоны. Только для событий входа и выхода из геозон

getMileage – пробег за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) - время окончания интервала
Возвращаемые значения
Boolean status - – true/false true в случае успешной операции.
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double Mileage – пробег в км. за указанный интервал, точность до 0.1 км
String error – текст сообщения об ошибке в случае возникновения ошибки

getEngineOnTime – время работы двигателя за период

Входные значения
String sessionId - идентификатор сессии, полученный во время авторизации
Integer objectId - идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) - время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double engineOnTime – суммарное время работы двигателя, в секундах
String error – текст сообщения об ошибке в случае возникновения ошибки

getVehiclesState – текущее состояние ТС

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
VehiclesType vehicles – Список ID транспортных средств
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
vehicleStatesType states – Список параметров характеризующих состояние для каждого ТС

getMileageSpeedExcess – пробег с превышением скорости за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции.
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double mileageSpeedExcess – пробег c превышением скорости в км. за указанный интервал, точность до 0.1 км
String error – текст сообщения об ошибке в случае возникновения ошибки

getMovementTime – время движения за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции.
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double movementTime – время движения за период, в секундах
String error – текст сообщения об ошибке в случае возникновения ошибки

getEngineOnTimeInMovement – время работы двигателя в движении за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double engineOnTimeInMovement – время работы двигателя в движении за период, в секундах
String error – текст сообщения об ошибке в случае возникновения ошибки

getEngineOnTimeWithoutMovement – время работы двигателя без движении за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status – true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double engineOnTimeWithoutMovement – время работы двигателя без движения за период, в секундах
String error – текст сообщения об ошибке в случае возникновения ошибки

getEngineOffTime – время с выключенным двигателем за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double engineOffTime – время с выключенным двигателем за период, в секундах
String error – текст сообщения об ошибке в случае возникновения ошибки

getFuelConsumptionInMovement – расход топлива в движении

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double fuelConsumptionInMovement – расход топлива в движении за период, литры, с точностью до 0.1 литра
String error – текст сообщения об ошибке в случае возникновения ошибки

getFuelConsumptionWithoutMovement – расход топлива без движения

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения

| Boolean status – true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double fuelConsumptionWithout Movement – расход топлива без движения за период, литры, с точностью до 0.1 литра
String error – текст сообщения об ошибке в случае возникновения ошибки |

getFuelConsumptionInMotohour – расход топлива на моточас

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double fuelConsumptionIn Motohour – средний расход топлива на моточас за период, литры, с точностью до 0.1 литра
String error – текст сообщения об ошибке в случае возникновения ошибки

getFuelAtTime – уровень топлива в момент времени

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp time (секунды) – момент времени
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp time (секунды) – момент времени
Double fuelAtTime – уровень топлива на момент времени, литры, с точностью до 0.1 литра
String error – текст сообщения об ошибке в случае возникновения ошибки

getUserNotificationsByPeriod – уведомления пользователя за период

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды. Если не указано, то время окончания периода = системному времени начала обработки запроса сервером
Integer page – Номер запрашиваемой страницы данных. Если не задан, то возвращается первая страница содержащая perPage записей
Integer perPage – Количество записей на страницу, если не задано, то считается неограниченным
Возвращаемые значения
Boolean status – Статус выполнения операции. True в случае успешной операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC) , секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
userNotificationsType userNotifications – Массив наборов возвращаемых параметров
Integer notificationsCount – Общее количество уведомлений по всем страницам. Если не найдено ни одного уведомления, то возвращается код ошибки 10

getVisitedGeozonesByPeriod – геозоны, посещенные за период

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время начала периода (UTC), секунды
vehicleIdsType vehicleId – Список ID транспортных средств. Если отсутствует, то запрос выполняется по всем ТС, доступным пользователю
Возвращаемые значения
Boolean status – Статус выполнения операции.
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
visitedGeozone geozoneVisits – Блок массивов параметров посещенных геозон

getVehiclesParams – список параметров доступных пользователю

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Vehicle vehicles – параметры ТС, право на просмотр которых имеет текущий пользователь

signOut – завершение сессии

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
String sessionId – ИД завершенной сессии

getActiveNotificationRules – профили активных уведомлений

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
rulesType rules – Параметры по каждому профилю уведомлений

setDeviceIdToNotificationRules – присвоение ТС профилей уведомлений

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
String deviceId – идентификатор устройства
String deviceTypeId – Идентификатор типа устройства
rulesType rules – идентификаторы профилей уведомлений для которых необходимо назначить ТС
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки

getFuelLevelsByTimeMoment – уровень топлива в момент времени

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeMoment – Момент времени (UTC), секунды
vehicleAndTankIdsType
vehicleAndTankIds – Список ID транспортных средств и ёмкостей. Если отсутствует, то запрос выполняется по всем ТС и ёмкостям, доступным пользователю
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeMoment – Момент времени (UTC), секунды
fuelData fuelDataSet – список параметров по каждому ТС:
int vehicleId – Идентификатор ТС;
int tankNumber – Номер топливной ёмкости;
fuelLevelsType fuelLevels – Данные об уровне топлива;
activityPeriodsType activityPeriods – данные по работе двигателя;
ignitionOffListType ignitionOffList – данные по выключению зажигания;
ignitionOnListType ignitionOnList – данные по включению зажигания;
llsFailurePeriodsType
llsFailurePeriods – данные по сбоям датчика уровня топлива

getFuelLevelsByPeriod – уровень топлива за период

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды. Если не указано, то время окончания периода = системному времени начала обработки запроса сервером
VehicleAndTankIdsType
vehicleAndTankIds – Список ID транспортных средств и ёмкостей. Если отсутствует, то запрос выполняется по всем ТС и ёмкостям, доступным пользователю
Int reduce – прореживание:
0 = не требуется
1 = требуется
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
fuelData fuelDataSet – список параметров по каждому ТС:
int vehicleId – Идентификатор ТС;
int tankNumber – Номер топливной ёмкости;
fuelLevelsType fuelLevels – Данные об уровне топлива;
activityPeriodsType activityPeriods – данные по работе двигателя;
ignitionOffListType ignitionOffList – данные по выключению зажигания;
ignitionOnListType ignitionOnList – данные по включению зажигания;
llsFailurePeriodsType
llsFailurePeriods – данные по сбоям датчика уровня топлива

getSmoothedFuelLevelsByPeriod – сглаженные уровни топлива за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
vehicleAndTankIdsType vehicleAndTankIds – Список ID транспортных средств и ёмкостей. Если отсутствует, то запрос выполняется по всем ТС и ёмкостям, доступным пользователю
Int reduce – прореживание:
0 = не требуется
1 = требуется
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
fuelData fuelDataSet – список параметров по каждому ТС:
int vehicleId – Идентификатор ТС;
int tankNumber – Номер топливной ёмкости;
fuelLevelsType fuelLevels – Данные об уровне топлива;
activityPeriodsType activityPeriods – данные по работе двигателя;
ignitionOffListType ignitionOffList – данные по выключению зажигания;
ignitionOnListType ignitionOnList – данные по включению зажигания;
llsFailurePeriodsType
llsFailurePeriods – данные по сбоям датчика уровня топлива

getRefuelingsAndDrainsByPeriod – сливы и заправки за период

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
vehicleAndTankIdsType vehicleAndTankIds – Список ID транспортных средств и ёмкостей. Если отсутствует, то запрос выполняется по всем ТС и ёмкостям, доступным пользователю
Integer page – Номер запрашиваемой страницы данных
Integer perPage – Количество записей на страницу, если не задан, то считается неограниченным
String sortname – Поле, по которому необходимо отсортировать возвращаемые параметры
String sortorder – порядок сортировки:
asc – по возрастанию
desc – по убыванию
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
Integer entriesCounter – общее количество записей за период
RefuelingsAndDrainsType
RefuelingsAndDrains – список параметров по каждому ТС

getVehiclesProfiles – профили ТС соответствующие идентификаторам ТС

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
VehiclesType vehicles – Список ID транспортных средств
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Vehicles – список параметров профиля для каждого ТС

getCurrentObjectState – текущее состояние ТС

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Возвращаемые значения
Boolean status – true/false. True в случае успешной операции.
String error - текст сообщения об ошибке в случае возникновения ошибки
String lastGPS – последние валидные координаты. Содержит значения широты и долготы через точку с запятой
Integer lastGPSDir – направление движения, в градусах от 0 до 359
Double currentSpeed – скорость на текущий момент времени, в км/ч с точностью до 0.1 км/ч
Double currentFuel – уровень топлива на текущий момент времени, в литрах с точностью до 0.1 литра
Boolean currentIgn – состояние зажигания. True при включенном зажигании
Boolean speedExceed – превышение порога скорости. True при превышении порога скорости
Integer lastGPSSat – количество спутников с последними валидными координатами
Double currentInputValue – значение универсального входа на текущий момент времени. Атрибуты: Integer number – номер УВ, String name – название УВ

getReportData – отчет за период по доп оборудованию, TPMS, IQFreeze

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Long timeBegin – Время начала периода (UTC), екунды
Long timeEnd – Время окончания периода (UTC), с
String reportTemplateID – идентификатор шаблона отчета Omnicomm Online. Возможные значения: addEquipment, TPMS, refState, refWork
Возвращаемые значения
Boolean status – true / false. True в случае успешной операции
String error – текст сообщения об ошибке в случае возникновения ошибки
ReportDataType reportData – массив, содержащий данные отчета

getSEOnTime – время работы дополнительного оборудования

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) - время окончания интервала
Возвращаемые значения
Boolean status - true/false true в случае успешной операции
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Double sEOnTime (секунды) – время работы дополнительного оборудования для каждого подключенного УВ. Атрибуты: Integer number – номер УВ, String name – название УВ

getStatisticsByPeriod – статистика за период

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды. Если не указано, то время окончания периода = системному времени начала обработки запроса сервером.
int objectType – Тип объекта:
0=ТС;
1=водитель;
В случае указания несуществующего типа объекта должен вернуться код ошибки 12.
objectIdsType objectIds – Массив типа objectIdsType, содержащий список параметров objectId типа int. Если отсутствует, то запрос выполняется по всем ID объектов соответствующего типа, доступным пользователю.
requiredStatParamsType requiredStatParams – Список требуемых подгрупп параметров отчета «Статистика». Если передается пустой список, то должны вернуться все все подгруппы со всеми параметрами, иначе только перечисленные подгруппы
Возвращаемые значения
movingAndWorkingParamsType movementAndWorkingParams – Подгруппа параметров по движению и работе ТС. Если передается пустой список, то должны вернуться все параметры подгруппы, иначе только перечисленные. Если подгруппа не передается, то не возвращается вся подгруппа.
fuelParamsType fuelParams –Подгруппа параметров по топливу, сливам и заправкам. Если передается пустой список, то должны вернуться все параметры подгруппы, иначе только перечисленные. Если подгруппа не передается, то не возвращается вся подгруппа.
optionalEquipmentParamsType optionalEquipmentParams – Подгруппа параметров по доп. оборудованию на универсальных входах. Если передается пустой список, то должны вернуться все параметры подгруппы, иначе только перечисленные. Если подгруппа не передается, то не возвращается вся подгруппа.
CANDataParamsType CANDataParams – подгруппа параметров CAN. Если передается пустой список, то должны вернуться все параметры подгруппы, иначе только перечисленные. Если подгруппа не передается, то не возвращается вся подгруппа.
addDataParamsType addDataParams – подгруппа дополнительных параметров статистики: TPMS, iQFreeze и т.д.

getTracksByPeriod – треки ТС за период

Входные значения
String sessionId – ИД сессии, полученный во время авторизации
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды. Если не указано, то время окончания периода = системному времени начала обработки запроса сервером
VehiclesType vehicles – Список ID транспортных средств
Int reduce – прореживание:
0 = не требуется
1 = требуется
Возвращаемые значения
Boolean status – Статус выполнения операции
String error – Текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin – Время начала периода (UTC), секунды
Unixtimestamp timeEnd – Время окончания периода (UTC), секунды
trackDataSetType trackDataSet – Параметры трека по каждому ТС:
trackPoint – параметры точки трека по одному ТС
unixtimestamp timestamp – Время, на которое зафиксированы координаты
Integer latitude – Широта с точностью 0,0000001 градуса
Integer longitude – Долгота с точностью 0,0000001 градуса
Integer direction – Направление, градусы
Integer sattelitesCount – Количество спутников
Double speed (км/ч) – Скорость
Long timeStamp (секунды) – Время события. (UTC)

getTrack – трек

Входные значения
String sessionId – идентификатор сессии, полученный во время авторизации
Integer objectId – идентификатор объекта
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Возвращаемые значения
Boolean status – true/false true в случае успешной операции
String error – текст сообщения об ошибке в случае возникновения ошибки
Unixtimestamp timeBegin (секунды) – время начала интервала
Unixtimestamp timeEnd (секунды) – время окончания интервала
Dataset trackEvents – набор точек трека:
String gpsPos – координаты события. Содержит значения широты и долготы через точку с запятой
Integer gpsDir – направление движения, в градусах от 0 до 359
Integer sattelitesCount – количество спутников
Double speed – скорость, в км/ч с точностью до 0.1 км/ч
Unixtimestamp timeStamp – дата и время точки

Список методов REST API

/api/service/geozones/geozones GET – получение данных по геозонам пользователя

Геозоны пользователя разбиваются на страницы. В запросе можно указать необходимую страницу и количество геозон на странице.

Входные значения
String Bearer {SessionID} or JWT {JWT} – идентификатор сессии, полученный во время авторизации. Например, для SessionID: Bearer 611ed1554ced2e10d13938bbd18482b060cb20f1
Integer page – номер страницы с геозонами пользователя. Если значение не указано, возвращается первая страница
Integer pageSize – количество геозон на странице. Возможные значения: от 1 до 50. Значение по умолчанию: 20
Возвращаемые данные
Integer total – общее количество геозон
Integer page – номер текущей страницы с геозонами пользователя
Integer pageSize – количество геозон на странице
Dataset rows – перечень геозон:
String name – название геозоны
Integer id – идентификатор геозоны
Integer rootGroupId – корневая группа геозоны
Integer geozoneTypeId – идентификатор типа геозоны
string geozoneTypeName – тип геозоны
Number radius – радиус геозоны с типом «круг»
Integer geometryTypeId – идентификатор формы геозоны. Для геозоны с типом «круг» используется полигон
String geometryTypeName – форма геозоны
Integer lineWidth – ширина геозоны с типом «линия»
Integer status – идентификатор статуса (активна/неактивна)
String statusName – статус
String uuid – идентификатор uuid геозоны
Number latitude – широта географической токи центра геозоны с типом «круг»
Number longitude – долгота географической токи центра геозоны с типом «круг»
Integer countPoints – количество точек в геозоне
Dataset points – точки геозоны:
Integer pointId – идентификатор точки
Number latitude – широта
Number longitude – долгота

/api/service/geozones/geozone-groups GET – получение данных по всем группам геозон пользователя

Входные значения
String Bearer {SessionID} or JWT {JWT} – идентификатор сессии, полученный во время авторизации. Например, для SessionID: Bearer 611ed1554ced2e10d13938bbd18482b060cb20f1
Возвращаемые данные
geozoneIds – идентификаторы геозон, которые не входят в группы
Integer geozoneIds – идентификатор геозоны
Dataset groups – перечень групп геозон:
Integer Id – идентификатор группы
Integer parentGroupId – идентификатор родительской группы
String name – название группы
geozoneIds – идентификаторы геозон, которые входят в группу
Integer geozoneIds – идентификатор геозоны

Ошибки

Список возвращаемых ошибок:

0: No errors – ошибок нет

1: Signing in failed – неправильно введен логин / пароль

2: Authorization required – для доступа к данным необходима авторизация

3: Dead session number – сессия закончена, необходимо авторизоваться заново

4: Bad interval – неправильно введен временной интервал

5: Bad object – объекта с таким идентификатором не существует

6: Admin login – попытка авторизации от имени пользователя с правами Администратора

7: Unusable object – значение не может быть рассчитано для объекта с данным идентификатором

8: Bad event type – типа события с таким идентификатором не существует

9: Access denied – нет прав доступа на объект

10: Data not found – не найдены данные для соответствующих входных значений

11: Blocked interval – запрашиваемый период содержит периоды блокировки данных

12: Bad object type – указанный тип объекта не существует.

13: Invalid format – неверный формат

14: Undefined error – неопределенная ошибка

15: 404 – несуществующая страница

Типы событий

Номер типа события Значение Значение parameters и примечания
1 Начало заправки (для топливозаправщиков – начало залива) Объем заправки, в литрах, с точностью до 0.1
2 Окончание заправки (для топливозаправщиков – окончание залива) Объем заправки, в литрах, с точностью до 0.1
3 Начало слива Объем слива, в литрах, с точностью до 0.1
4 Окончание слива Объем слива, в литрах, с точностью до 0.1
5 Включение зажигания Время от момента прошлого выключения зажигания, в минутах
6 Выключение зажигания
7 Включение внешнего питания
8 Включение питания от аккумулятора
9 Авторизация водителя В поле iButton возвращается код ключа в шестнадцатеричном виде
10 Включение роуминга
11 Отключение роуминга
12 Мгновенное превышение скорости Максимальное значение скорости за, км/ч, с точностью до 0.1
13 Простой
14 Начало превышения скорости
15 Начало группы выдач (для топливозаправщиков) Начало группы выдач (для топливозаправщиков)
16 Окончание группы выдач (для топливозаправщиков) Объем топлива после окончания группы выдач, в литрах, с точностью до 0.1
17 Начало залива во время группы выдач (для топливозаправщиков)
18 Окончание залива во время группы выдач (для топливозаправщиков)
19 Начало слива во время группы выдач (для топливозаправщиков)
20 Окончание слива во время группы выдач (для топливозаправщиков)
21 Выход бортового оборудования на связь
22 Включение дополнительного оборудования
23 Выключение дополнительного оборудования
24 Выход за предельное значение дополнительного оборудования
25 Возврат в нормальное значение дополнительного оборудования
31 Нажатие тревожной кнопки
32 Перегрузка дополнительного оборудования
33 Питание включено
34 Мгновенное превышение допустимых оборотов
35 Вход в геозону
36 Выход из геозоны
38 Питание выключено
42 Начало остановки
43 Окончание остановки
44 Начало ускорения
45 Окончание ускорения
46 Включение дискретного входа
47 Выключение дискретного входа
48 Мгновенное ускорение
49 Водитель не известен
52 Вскрытие устройства
53 Водитель конец авторизации
54 Приложен iButton
55 Регистрация удаленного водителя

Пример рабочего клиента

Импорт интерфейсов

wsimport -d bin -s src http://demo.omnicomm.ru:8000/AnalyticalServer/ws?wsdl

Java-код:

Строки «user» и «pass» необходимо заменить реальными значениями.

package ru.omnicomm.test.client;

import ru.omnicomm.analyticalserver.*;

import java.net.MalformedURLException; 

import java.net.URL; 

import java.util.List;

public class  ExampleClient { 
    public static void main(String[] args) throws MalformedURLException {
        AnalyticalServer = new AnalyticalServer(new URL("http://demo.omnicomm.ru:8000/AnalyticalServer/ws?wsdl")); 

        AnalyticalServerWS port = AnalyticalServer.getAnalyticalServerPort(); 

        AuthResponseEntry auth = port.signIn("user", "pass"); 

        String sessionId = auth.getsessionId (); 

        System.out.println("auth sessionId: " + sessionId); 

        ObjectSetResponseEntry objects = port.getObjectSet(sessionId); 
        List<Vehicle> vehicles = objects.getVehicleList(); 

        for (Vehicle vehicle : vehicles) { 
            System.out.printf("vehicle: %d / %s\n", vehicle.getVehicleID(), vehicle.getRegNmb()); 
        }

    }
}