Список методов 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 транспортных средств и ёмкостей. Если отсутствует, то запрос выполняется по всем ТС, доступным пользователю tankNumber – указание номера топливной ёмкости (1 - основная, 2 - дополнительная) 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 – дата и время точки |
getEngineStatisticsByPeriod – статистика работы двигателя за период
| Входные значения |
|---|
| String sessionId – идентификатор сессии, полученный во время авторизации Integer vehicleId – идентификатор ТС Unixtimestamp timeBegin (секунды) – время начала интервала Unixtimestamp timeEnd (секунды) – время окончания интервала |
| Возвращаемые значения |
|---|
| Boolean status – true/false true в случае успешной операции String error – текст сообщения об ошибке в случае возникновения ошибки Unixtimestamp timeBegin (секунды) – время начала интервала Unixtimestamp timeEnd (секунды) – время окончания интервала Unixtimestamp lastDataTimestamp (секунды) – метка времени последних обработанных данных (UTC) Unixtimestamp operationStartDate (секунды) – время начала работы за период (UTC) Unixtimestamp operationEndDate (секунды) – время окончания работы за период (UTC) Integer operationTime (секунды) – время работы за период Integer engineOffTime (секунды) – время с выключенным двигателем за период Integer engineOnTime (секунды) – время с включенным двигателем за период Integer engineIdlingTime (секунды) – время работы двигателя на холостом ходу за период Integer engineOperationTimeNormalSpeed (секунды) – время работы под номинальной нагрузкой за период Integer engineOperationTimeMaxSpeed (секунды) – время работы с превышением предельной нагрузки за период Integer engineLoadTime (секунды) – время работы под нагрузкой за период Integer dataAbsenceTime (секунды) – время отсутствия данных за период |
getShiftDataByPeriod – информация по сменам
| Входные значения |
|---|
| String sessionId – идентификатор сессии, полученный во время авторизации Unixtimestamp timeBegin (секунды) – время планового начала смены Unixtimestamp timeEnd (секунды) – время планового окончания смены Integer devBeforeBegin (секунды) – допустимое опережение фактической даты начала смены плановой даты начала смены Integer devAfterBegin (секунды) – допустимое отставание фактической даты начала смены от плановой даты начала смены Integer devBeforeEnd (секунды) – допустимое опережение фактической даты окончания смены плановой даты окончания смены Integer devAfterEnd (секунды) – допустимое отставание фактической даты окончания смены от плановой даты окончания смены Integer vehicleId – идентификатор ТС |
| Возвращаемые значения |
|---|
| Boolean status – true/false true в случае успешной операции String error – текст сообщения об ошибке в случае возникновения ошибки Integer vehicleId – идентификатор ТС Integer vehicleType – тип ТС (0 - машина, 1 - топливозаправщик) shiftData: Unixtimestamp pointDate (секунды) – время фактического начала/ окончания смены (UTC) |
getIntervalsInfo – информация с разбиением на интервалы
| Входные значения |
|---|
| String sessionId – идентификатор сессии, полученный во время авторизации Integer vehicleId – идентификатор ТС Unixtimestamp timeBegin (секунды) – время начала интервала Unixtimestamp timeEnd (секунды) – время окончания интервала Boolean partsFlag – разбивка на части (true or false) Integer interval (мин) – длина интервала Boolean geocodingFlag – разрешение адреса по координатам(true or false) Boolean additionalTankFlag – возвращение набора данных об уровне топлива в дополнительной ёмкости(true or false) |
| Возвращаемые значения |
|---|
| Boolean status – true/false true в случае успешной операции Integer errorCode – код ошибки. Возможные коды ошибок: 2: Authorization required - для доступа к данным необходима авторизация 3: Dead session number – сессия закончена, необходимо авторизоваться заново 4: Bad interval – неправильно введен временной период 5: Bad object – ТС с таким идентификатором не существует 7: Unusable object– значение не может быть рассчитано для объекта с данным идентификатором. 9: Access denied – нет прав доступа на объект 10: Data not found – не найдены данные для соответствующих входных значений (ни одного события сырых данных за [период запроса + одно событие до начала периода]) 11:Blocked interval – запрашиваемый период содержит периоды блокировки данных 13: Invalid format – неверный формат 14: Undefined error – неопределенная ошибка 19: Too many intervals: current N, allowed M - количество интервалов за период (N) превышает лимит (M) String erorrDescription – опционально Integer vehicleId – идентификатор ТС Integer vehicleType – тип ТС(0 - машина, 1 - топливозаправщик) Integer tanksNumber – количество топливных емкостей Integer numberOfIntervals – количество интервалов разбиения в периоде запроса periodData – набор данных за период запроса intervalsData – данные по интервалу: Integer intervalNumber – порядковый номер интервала |
