Lista de métodos SOAP
Se utiliza el formato UNIXTIME (en segundos) para la fecha y el tiempo en que los datos fueron transmitidos. A continuación se enumeran las unidades de los demás parámetros.
signIn – autorización
| Valores de entrada |
|---|
| String login – nombre de usuario en el sistema String password – contraseña en el sistema |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una autorización exitosa String sessionId – en caso de una autenticación exitosa, el identificador de sesión (mínimo de 16 carácteres) Unixtimestamp dateTimeEnd – en caso de una autenticación exitosa, el tiempo de la terminación de sesión (el tiempo después de que debería iniciar sesión de nuevo) String error – mensaje de error en caso de autorización inadecuada (usuario y contraseña introducida incorrectamente, o formato de datos incorrecto) |
getObjectSet – lista de objetos
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una autorización exitosa String error – mensaje de error en caso de que ocurra un error Dataset objects – lista de vehículos disponibles al usuario - dueño de la sesión registrada (es decir, solo aquellos objetos a los que el usuario tiene derecho ver): Integer id – identificador del objeto (la misma que el identificador de la unidad) String objectName – nombre del vehículo String objectType – tipo de vehículo String GarageNumber – número de garage |
getSmoothedFuel – nivel de combustible suavizado para el periodo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenido durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Dataset fuel – conjunto de datos (todos los datos del archivo para el periodo seleccionado): Unixtimestamp timeStamp – tiempo del nivel de combustible registrado Double smothedFuel – valor suavizado de combustible, litros, precisión de hasta 0.1 l String error – mensaje de error en caso de ocurrir un error |
getFuelConsumption – consumo de combustible para el periodo
| Valores de entrada |
|---|
| String sessionId - identificador de la sesión obtenido durante la autorización Integer objectId - identificador del vehículo / unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) - tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una autorización exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double fuelConsumption – consumo de combustible para el periodo, litros, precisión de hasta 0.1 l String error – mensaje de error en caso de ocurrir un error |
getEvents – lista de eventos
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad. Parámetro opcional, si el identificador no está presente, devuelve los datos para todos los vehículos Integer type – tipo de evento, requerido Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) - tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una autorización exitosa. String error - mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Dataset objectEvents – conjunto de datos para el evento: Unixtimestamp timeStamp – fecha y tiempo del evento Integer objectId – identificador del vehículo / unidad String type – tipo de evento String parameters – parámetros del evento String eventAddress – difrección del evento, si está disponible String iButton – código iButton en HEX. Solamente para eventos tales como 'Conductor' String name – nombre de la geocerca. Solamente para la entrada y salida de los eventos de Geocerca |
getMileage – kilometraje del periodo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) - tiempo final del vehículo |
| Valores de retorno |
|---|
| Boolean status - – verdadero/falso verdadero en el caso de una operación exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double Mileage – kilometraje en km para el intervalo en específico, precisión de 0.1 km String error – mensaje de error en caso de que ocurra un error |
getEngineOnTime – tiempo de funcionamiento del motor para el periodo
| Valores de entrada |
|---|
| String sessionId - identificador de sesión obtenido durante la autorización Integer objectId - identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) - tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double engineOnTime – tiempo de operacion total del motor, en segundos String error – mensaje de error en caso de que ocurra un error |
getVehiclesState – estado actual del vehículo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenida durante la autorización VehiclesType vehicles – lista de identificación del vehículo |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error vehicleStatesType states – lista de parámetros que describen cada estado del vehículo |
getMileageSpeedExcess – kilometraje con exceso de velocidad para el periodo
| Valores de entrada |
|---|
| String sessionId – identificador de la sesión obtenido durante la autorización Integer objectId – identificador del vehículo / unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una autorización exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double mileageSpeedExcess – kilometraje con velocidad en km para el intervalo en específico, precisión 0.1 km String error – mensaje de error en caso de que ocurra un error |
getMovementTime – tiempo en movimiento para el periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una autorización exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double movementTime – tiempo del movimiento, segundos String error – mensaje de error en caso de que ocurra un error |
getEngineOnTimeInMovement – tiempo de funcionamiento del motor en movimiento para el periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double engineOnTimeInMovement – tiempo de funcionamiento del motor durante el movimiento, segundos String error – mensaje de error en caso de ocurrir un error |
getEngineOnTimeWithoutMovement – tiempo de funcionamiento sin movimiento para el periodo
| Valores de entrada |
|---|
| String sessionId – identificador de la sesión obtenido durante la autorización Integer objectId – identificador del vehículo / unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una operación exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double engineOnTimeWithoutMovement – tiempo de funcionamiento del motor sin movimiento, segundos String error – mensaje de error en caso de que ocurra un error |
getEngineOffTime – tiempo de inactividad del motor para el periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double engineOffTime – tiempo de apagado del motor durante el periodo, segundos String error – mensaje de error en caso de que ocurra un error |
getFuelConsumptionInMovement – consumo de combustible durante el movimiento del periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double fuelConsumptionInMovement – consumo de combustible durante el movimiento para el periodo, litros, precisión 0.1 litros String error – mensaje de error cuando ocurra un error |
getFuelConsumptionWithoutMovement – consumo de combustible sin movimiento para el periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una operación exitosa. Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double fuelConsumptionWithout Movement – consumo de combustible sin movimiento para el periodo, litros, precisión 0.1 l String error – mensaje de error cuando ocurra un error |
getFuelConsumptionInMotohour – consumo de combustible por hora de funcionamiento del motor
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double fuelConsumptionIn Motohour – consumo de combustible promedio para la hora de motor del periodo, litros, precisión 0.1 l String error – mensaje de error cuando ocurra un error |
getFuelAtTime – nivel de combustible en un momento determinado
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp time (segundos) – momento del tiempo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en caso de una operación exitosa Unixtimestamp time (segundos) – momento del tiempo Double fuelAtTime – nivel de combustible en un momento dado, litros, precisión 0.1 l String error – mensaje de error en caso de que ocurriera un error |
getUserNotificationsByPeriod – notificaciones de usuario acumuladas hasta el inicio del periodo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenido durante la autorización Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos. Si no está definido, tiempo final = tiempo del sistema de ejecución de solicitud por el servidor Integer page – número de página solicitado. Si no está definido, se retorna la primera página que contenga los registros perPage (por página) Integer perPage – cantidad de registros por página, si no está definido, la cantidad no está limitada |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento. Verdadero en caso de una operación exitosa. String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos userNotificationsType userNotifications – serie de conjuntos de parámetros de retorno Integer notificationsCount – número total de notificaciones para todas las páginas. Si no se encuentra notificación, se devuelve el código de error 10 |
getVisitedGeozonesByPeriod – geocercas visitadas hasta el inicio del periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos vehicleIdsType vehicleId – lista de identificaciones del vehículo. Si no existe, se utilizan todos los vehículos disponibles para la solicitud |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos visitedGeozone geozoneVisits – serie de conjunto de parámetros de geocercas visitadas |
getVehiclesParams – lista de parámetros disponibles al usuario
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Vehicle vehicles – parámetros de vehículo que el usuario actual tiene derecho a consultar |
signOut – término de la sesión
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error String sessionId – identificación de sesión terminada |
getActiveNotificationRules – perfiles de notificaciones activas
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurriera un error rulesType rules – parámetros para cada perfil de notificación |
setDeviceIdToNotificationRules – asignación de perfiles de notificación al vehículo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización String deviceId – identificación del dispositivo String deviceTypeId – identificador del tipo de dispositivo rulesType rules – identificadores de perfiles de notificación que son necesarios asignar al vehículo |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error |
getFuelLevelsByTimeMoment – nivel de combustible en un tiempo determinado
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenido durante la autorización Unixtimestamp timeMoment – momento del tiempo (UTC), segundos vehicleAndTankIdsType vehicleAndTankIds – llista de identicaciones de vehículos y tanques de combustible. Si no hay una lista, se ejecutará la solicitud para todos los vehículos y tanques disponibles al usuario |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurriera un error Unixtimestamp timeMoment – momento del tiempo (UTC), segundos fuelData fuelDataSet – lista de parámetros para cada vehículo: int vehicleId – identificador del vehículo int tankNumber – número de tanque de combustible fuelLevelsType fuelLevels – datos de nivel de combustible activityPeriodsType activityPeriods – datos de funcionamiento del motor ignitionOffListType ignitionOffList – datos de apagado de ignición ignitionOnListType ignitionOnList – datos de encendido de ignición llsFailurePeriodsType llsFailurePeriods – datos de fallos del sensor de nivel de combustible |
getFuelLevelsByPeriod – nivel de combustible registrado hasta el inicio del periodo de tiempo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos. Si no está indicado el tiempo final, el tiempo final del periodo = el tiempo de inicio del sistema del proceso de solicitud de parte del Servidor VehicleAndTankIdsType vehicleAndTankIds – lista de identicaciones de vehículos y tanques de combustible. Si no hay una lista, se ejecutará la solicitud para todos los vehículos y tanques disponibles al usuario Int reduce – raleo: 0 = no requerido 1 = requerido |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin – tiempo de inicio del periodo (UTC), segundos Unixtimestamp timeEnd – tiempo final del periodo (UTC), segundos fuelData fuelDataSet – lista de parámetros para cada vehículo: int vehicleId – identificador del vehículo int tankNumber – número de tanque de combustible fuelLevelsType fuelLevels – datos de nivel de combustible activityPeriodsType activityPeriods – datos de funcionamiento del motor ignitionOffListType ignitionOffList – datos de apagado de ignición ignitionOnListType ignitionOnList – datos de encendido de ignición llsFailurePeriodsType llsFailurePeriods – datos de fallos del sensor de nivel de combustible |
getSmoothedFuelLevelsByPeriod – niveles de combustible suavizados por periodo de tiempo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenida durante la autorización Integer objectId – identificador del objeto Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo vehicleAndTankIdsType vehicleAndTankIds – lista de identificaciones de los vehículos y tanques de combustible. Si no hay una lista, se ejecutará la solicitud para todos los vehículos y tanques disponibles al usuario Int reduce – raleo: 0 = no requerido 1 = requerido |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin – tiempo de inicio del periodo (UTC), segundos Unixtimestamp timeEnd – tiempo final del periodo (UTC), segundos fuelData fuelDataSet – lista de parámetros para cada vehículo: int vehicleId – identificador del vehículo int tankNumber – número de tanque de combustible fuelLevelsType fuelLevels – datos de nivel de combustible activityPeriodsType activityPeriods – datos de funcionamiento del motor ignitionOffListType ignitionOffList – datos de apagado de ignición ignitionOnListType ignitionOnList – datos de encendido de ignición llsFailurePeriodsType llsFailurePeriods – datos de fallos del sensor de nivel de combustible |
getRefuelingsAndDrainsByPeriod – operaciones de drenaje/recarga de combustible hasta le inicio del periodo de tiempo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo vehicleAndTankIdsType vehicleAndTankIds – lista de identificaciones de los vehículos y tanques de combustible. Si no hay una lista, se ejecutará la solicitud para todos los vehículos y tanques disponibles al usuario Integer page – número de la página solicitada con datos Integer perPage – número de entradas por página; si no está presente, se tomará como ilimitada String sortname – campo donde se debe de acomodar los parámetros de retorno String sortorder – orden de calificación: asc – ascendente desc – decreciente |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurriera un error Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos Integer entriesCounter – número total de entradas por periodo de tiempo RefuelingsAndDrainsType RefuelingsAndDrains – lista de parámetros para cada vehículo |
getVehiclesProfiles – perfiles de vehículo coincidentes con los identificadores de vehículo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenida durante la autorización VehiclesType vehicles – lista de identificación del vehículo |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Vehicles – lista de parámetros para cada vehículo |
getCurrentObjectState – estado actual del vehículo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del objeto |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en caso de una operación exitosa. String error - mensaje de error en caso de que ocurra un error String lastGPS – últimas coordinadas válidas. Contiene valores de latitud y longitud separados por un punto y coma Integer lastGPSDir – dirección de movimiento, grados de 0 a 359 Double currentSpeed – velocidad actual en un momento dado, en kph, precisión 0.1 kph Double currentFuel – nivel de combustible actual, en litros, precisión 0.1 l Boolean currentIgn – estado de ignición. Verdadero si la ignición está ENCENDIDA Boolean speedExceed – exceso del límite de velocidad. Verdadero en caso de límite de velocidad excedida Integer lastGPSSat – número de satélites con las últimas coordinadas válidas Double currentInputValue – valor actual de entrada universal. Atributos: Integer number – número UI, String name - nombre UI |
getReportData – informe de equipo auxiliar durante el periodo, TPMS, IQFreeze
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenida durante la autorización Integer objectId – identificador del objeto Long timeBegin – tiempo de inicio del intervalo (UTC), segundos Long timeEnd – tiempo final del intervalo (UTC), segundos String reportTemplateID – identificador de plantilla de informe en Omnicomm Online. Posibles valores: addEquipment, TPMS, refState, refWork |
| Valores de retorno |
|---|
| Boolean status – verdadero / falso verdadero en caso de una operación exitosa. String error – mensaje de error en caso de que ocurra un error ReportDataType reportData – serie que incluye los datos de informe |
getSEOnTime – tiempo de funcionamiento del equipo auxiliar correspondiente al periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador del vehículo/unidad Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) - tiempo final del vehículo |
| Valores de retorno |
|---|
| Boolean status - verdadero/falso verdadero en el caso de una operación exitosa Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Double sEOnTime (segundos) – tiempo de ejecución del equipo auxiliar para cada UI conectado. Atributos: Integer number – número UI, String name - nombre UI |
getStatisticsByPeriod – datos estadísticos del periodo
| Valores de entrada |
|---|
| String sessionId – identificador de sesión obtenido durante la autorización Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos. Si no está definido, tiempo final = tiempo del sistema de ejecución de solicitud por el servidor. int objectType – tipo de objeto: 0=vehículo 1=conductor Si el tipo no existe, se devuelve el código de error 12. objectIdsType objectIds – conjunto del tipo objectIdsType, que contiene lista de parámetros objectId del tipo int. En caso de no existir, se realiza la solicitud para todos los objectId del tipo correspondiente, disponible al usuario. requiredStatParamsType requiredStatParams – lista de todos los subgrupos requeridos para los parámetros del informe de 'estadística'. Si la lista está vacía, se devuelven todos los subgrupos con todos los parámetros |
| Valores de retorno |
|---|
| movingAndWorkingParamsType movementAndWorkingParams – subgrupo de los parámetros de funcionamiento y movimiento del vehículo. Si la lista está vacía, se devuelven todos los parámetros del subgrupo, sino, solamente se devuelven los parámetros que están enumerados. Si no se transmite el subgrupo, no se devolverá el subgrupo. fuelParamsType fuelParams – subgrupo de parámetros para combustible, drenaje y recargas de combustible. Si la lista está vacía, se devuelven todos los parámetros del subgrupo, sino, solamente se devuelven los parámetros que están enumerados. Si no se transmite el subgrupo, no se devolverá el subgrupo. optionalEquipmentParamsType optionalEquipmentParams – subgrupo de parámetros del equipo auxiliar. Si la lista está vacía, se devuelven todos los parámetros del subgrupo, sino, solamente se devuelven los parámetros que están enumerados. Si no se transmite el subgrupo, no se devolverá el subgrupo. CANDataParamsType CANDataParams – subgrupo de parámetros CAN. Si la lista está vacía, se devuelven todos los parámetros del subgrupo, sino, solamente se devuelven los parámetros que están enumerados. Si el subgrupo no está transmitido, se devolverá el subgrupo entero. addDataParamsType addDataParams – subgrupo de parámetros adicionales estadísticos: TPMS, iQFreeze, etc. |
getTracksByPeriod – rastreo del vehículo correspondiente al periodo
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos. Si no está indicado el tiempo final, el tiempo final del periodo = el tiempo de inicio del sistema del proceso de solicitud de parte del Servidor VehiclesType vehicles – lista de la identificación de vehículo Int reduce – raleo: 0 = no requerido 1 = requerido |
| Valores de retorno |
|---|
| Boolean status – estado de funcionamiento String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin – tiempo de inicio del intervalo (UTC), segundos Unixtimestamp timeEnd – tiempo final del intervalo (UTC), segundos trackDataSetType trackDataSet – parámetros de rastreo de cada vehículo: trackPoint – parámetros de rastreo por un solo vehículo unixtimestamp timestamp – tiempo en el evento cuando se corrigen las coordinadas Integer latitude – latitud con grado de precisión de 0.0000001 Integer longitude – longitud con grado de precisión de 0.0000001 Integer direction – dirección, grados Integer sattelitesCount – número de satélites Double speed (km/hour) – velocidad Long timeStamp (segundos) – tiempo del evento (UTC) |
getTrack – rastrear
| Valores de entrada |
|---|
| String sessionId – identificación de sesión obtenida durante la autorización Integer objectId – identificador de objeto Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalol Unixtimestamp timeEnd (segundos) – tiempo final del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso verdadero en el caso de una operación exitosa. String error – mensaje de error en caso de que ocurra un error Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo final del intervalo Dataset trackEvents – conjunto de puntos de rastreo: String gpsPos – coordinadas del evento. Contiene valores de latitud y longitud separados por un punto y coma Integer gpsDir – dirección de movimiento, grados de 0 a 359 Integer sattelitesCount – número de satélites Double speed – velocidad, en km/hora con una precisión de hasta 0.1 km/hora Unixtimestamp timeStamp – punto de fecha y tiempo |
getEngineStatisticsByPeriod – estadísticas de funcionamiento del motor durante un período
| Valores de entrada |
|---|
| String sessionId – identificador de sesión recibido durante la autorización Integer vehicleId – identificador del vehículo Unixtimestamp timeBegin (segundos) – hora de inicio del intervalo Unixtimestamp timeEnd (segundos) – hora de término del intervalo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso. Devuelve “verdadero” si la operación fue satisfactoria String error – texto del mensaje de error que aparece cuando se produce un error Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo de finalización del intervalo Unixtimestamp lastDataTimestamp (segundos) – indicación de tiempo de los últimos datos procesados (UTC) Unixtimestamp operationStartDate (segundos) – tiempo de inicio de la operación para el período (UTC) Unixtimestamp operationEndDate (segundos) – tiempo de finalización de la operación para el período (UTC) Integer operationTime (segundos) – tiempo de funcionamiento para el período Integer engineOffTime (segundos) – tempo de inactividad del motor para el período Integer engineOnTime (segundos) – tiempo de funcionamiento del motor para el período Integer engineIdlingTime (segundos) – tiempo de funcionamiento en reposo del motor para el período Integer engineOperationTimeNormalSpeed (segundos) – tiempo de funcionamiento del motor bajo carga normal para el período Integer engineOperationTimeMaxSpeed (segundos) – tiempo de funcionamiento del motor a carga máxima para el período Integer engineLoadTime (segundos) – tiempo de funcionamiento del motor bajo carga durante el período Integer dataAbsenceTime (segundos) – tiempo de ausencia de datos para el periodo |
getShiftDataByPeriod – información acerca de los turnos
| Valores de entrada |
|---|
| String sessionId – identificador de sesión recibido durante la autorización Unixtimestamp timeBegin (segundos) – tiempo de inicio de turno programado Unixtimestamp timeEnd (segundos) – tiempo de finalización de turno programado Integer devBeforeBegin (segundos) – desviación permitida desde la hora de inicio del turno antes del tiempo programado Integer devAfterBegin (segundos) – desviación permitida desde la hora de inicio del turno retrasado Integer devBeforeEnd (segundos) – desviación permitida desde la hora de final de turno antes del tiempo programado Integer devAfterEnd (segundos) – desviación permitida desde la hora de finalización del turno retrasado Integer vehicleId – identificador del vehículo |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso. Devuelve “verdadero” si la operación fue satisfactoria String error – texto del mensaje de error que aparece cuando se produce el error Integer vehicleId – identificador del vehículo Integer vehicleType – tipo de vehículo (0 - 1 - camión de combustible) shiftData: Unixtimestamp pointDate (segundos) – hora real de inicio/final del turno (UTC) |
getIntervalsInfo – información dividida en intervalos
| Valores de entrada |
|---|
| String sessionId – identificador de sesión recibido durante la autorización Integer vehicleId – identificador del vehículo Unixtimestamp timeBegin (segundos) – tiempo de inicio del intervalo Unixtimestamp timeEnd (segundos) – tiempo de finalización del intervalo Boolean partsFlag – división en partes (verdadero o falso) Integer interval (min) – longitud del intervalo Boolean geocodingFlag – resolución de dirección basándose en las coordenadas (verdadero o falso) Boolean additionalTankFlag – devuelve un conjunto de datos en el nivel de combustible en el tanque adicional (verdadero o falso) |
| Valores de retorno |
|---|
| Boolean status – verdadero/falso. Devuelve “verdadero” si la operación fue satisfactoria Integer errorCode – código de error. Los códigos de error posibles son: 2: Authorization required - se require una autorización para accesar los datos 3: Dead session number – se ha expirado la sesión, se necesita volver a dar autorización 4: Bad interval – se ha introducido un intervalo de tiempo inadecuado 5: Bad object – no existe objeto con este identificador 7: Unusable object– no se puede calcular el valor para un objeto con este identificador. 9: Access denied – no hay autorización para accesar el objeto 10: Data not found – no hay datos para los valores de entrada correspondientes (no hay datos crudos para [período de solicitud + un evento antes de que inicie el periodo]) 11:Blocked interval – el intervalo solicitado contiene períodos de bloqueo de datos 13: Invalid format – el formato es incorrecto 14: Undefined error – el error no está especificado 19: actual N, permitido M - el número de intervalos por período (N) supera el límite (M) String erorrDescription – opcional Integer vehicleId – identificador del vehículo Integer vehicleType – tipo de vehículo (0 - 1 - camión de combustible) Integer tanksNumber – el número de tanques de combustible Integer numberOfIntervals – el número de intervalos en el período de solicitud periodData – el conjunto de datos correspondiente al período de solicitud intervalsData – los datos correspondientes intervalo: Integer intervalNumber – número de secuencia del intervalo |
