Спасибо!

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

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

Ferramentas do site


Enviar nova senha

Por favor, digite o seu nome de usuário no formulário abaixo para requisitar uma nova senha para a sua conta nesse wiki. O link de confirmação será enviado para o endereço de e-mail que você forneceu.

Definir a nova senha para



Lista de métodos SOAP

Para transmitir data e hora, é usado o formato UNIXTIME (em segundos). As tipagens de outros parâmetros são listadas abaixo

signIn – autorização

Valores de entrada
String login – nome de usuário no sistema
String password – senha no sistema
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de autorização bem-sucedida
String sessionId – no caso de autenticação bem-sucedida, a ID de sessão (mínimo de 16 caracteres)
Unixtimestamp dateTimeEnd – em caso de autorização bem-sucedida, o término da sessão tempo após o qual você deve fazer login novamente)
String error – mensagem de erro em caso de autorização indevida (nome de usuário e senha digitados incorretamente ou formato de dados incorretos)

getObjectSet – lista de objetos

Valores de entrada
String sessionId – ID de sessão obtida durante a autorização
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
String error – mensagem de erro em caso de ocorrência de erro
Dataset objects – lista de veículos disponíveis para o usuário — proprietário da sessão registrado (ou seja, somente os objetos que o usuário tem direito de visualizar):
Integer id – identificador do objeto (o mesmo que o identificador da unidade)
String objectName – nome do veículo
String objectType – tipo do veículo
String GarageNumber – número da oficina

getSmoothedFuel – nível de combustível suavizado para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Dataset fuel – conjunto de dados (todos os dados arquivados para o período selecionado):
Unixtimestamp timeStamp – hora do nível de combustível registrado
Double smothedFuel – valor suavizado do combustível, litros, precisão até 0,1 l
String error – mensagem em caso de ocorrência de erro

getFuelConsumption – consumo de combustível para o período

Valores de entrada
String sessionId - identificador de sessão obtido durante da autorização
Integer objectId - identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) - hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida.
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double fuelConsumption – consumo de combustível para o período, litros, precisão de até 0,1 l
String error – mensagem em caso de ocorrência de erro

getEvents – lista de eventos

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade. Parâmetro opcional, se o identificador não estiver presente, retorna os dados para todos os veículos.
Integer type – tipo de evento, obrigatório.
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) - hora final do intervalo
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida.
String error - mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Dataset objectEvents – – conjunto de dados para cada evento:
Unixtimestamp timeStamp – data e hora do evento
Integer objectId – identificador do veículo/unidade
String type – tipo do evento
String parameters – parâmetros do evento
String eventAddress – endereço do evento, se disponível
String iButton – código iButton, em hexadecimal. Somente para eventos como 'Motorista'
String name – nome da cerca eletrônica. Apenas para entrada e saída ou de eventos de cerca eletrônica.

getMileage – quilometragem para o período

Valores de entrada
String sessionId – identificador de sessão durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) - hora de término do intervalo
Valores de retorno
Boolean status - – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida.
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double Mileage – quilometragem em km em intervalo especificado, precisão de 0,1 km
String error – mensagem em caso de ocorrência de erro

getEngineOnTime – tempo de funcionamento do motor para o período

Valores de entrada
String sessionId - identificador de sessão obtido durante a autorização
Integer objectId - identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) - hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double engineOnTime – duração total de funcionamento do motor, em segundos
String error – mensagem de erro em caso de ocorrência de erro

getVehiclesState – status atual do veículo

Valores de entrada
String sessionId – identificador de sessão obtido durante autorização
VehiclesType vehicles – lista de IDs de veículos
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
vehicleStatesType states – lista de parâmetros descrevendo cada status de veículo

getMileageSpeedExcess – quilometragem com excesso de velocidade para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida.
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double mileageSpeedExcess – quilometragem com excesso de velocidade em km para o intervalo especificado, precisão de 0,1 km
String error – mensagem de erro em caso de ocorrência de erro

getMovementTime – tempo em deslocamento para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida.
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double movementTime – tempo de deslocamento, segundos
String error – mensagem de erro em caso de ocorrência de erro

getEngineOnTimeInMovement – tempo de funcionamento do motor em deslocamento para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double engineOnTimeInMovement – tempo de funcionamento do motor em deslocamento, segundos
String error – mensagem em caso de ocorrência de erro

getEngineOnTimeWithoutMovement – tempo de funcionamento do motor em ociosidade para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double engineOnTimeWithoutMovement – tempo de funcionamento do motor em ociosidade, segundos
String error – mensagem de erro em caso de ocorrência de erro

getEngineOffTime – tempo com o motor desligado para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double engineOffTime – tempo de motor desligado para o período, segundos
String error – mensagem em caso de ocorrência de erro

getFuelConsumptionInMovement – consumo de combustível em movimento para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double fuelConsumptionInMovement – consumo de combustível durante o movimento para o período, litros, precisão de 0,1 litro
String error – mensagem em caso de ocorrência de erro

getFuelConsumptionWithoutMovement – consumo de combustível em movimento para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double fuelConsumptionWithout Movement – consumo de combustível em ociosidade para o período, litros, precisão de 0,1 l
String error – mensagem em caso de ocorrência de erro

getFuelConsumptionInMotohour – consumo de combustível por hora do motor

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double fuelConsumptionIn Motohour – consumo médio de combustível para a hora do motor para o período, litros, precisão de 0,1 l
String error – mensagem em caso de ocorrência de erro

getFuelAtTime – nível de combustível em um determinado momento

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp time (segundos) – horário do momento
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp time (segundos) – horário do momento
Double fuelAtTime – nível de combustível em um determinado momento, litros, precisão de 0,1 l
String error – mensagem em caso de ocorrência de erro

getUserNotificationsByPeriod – notificações do usuário no período

Valores de entrada
String sessionId – identificador de sessão obtido durante autorização
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos. Se não definido, o horário de término é o horário da execução de solicitação pelo servidor
Integer page – número da página solicitada. Se não definido, retorna a primeira página contém registros por página
Integer perPage – quantidade de registros por página, se não definido, a quantidade não é limitada
Valores de retorno
Boolean status – status da operação. Verdadeiro no caso de operação bem-sucedida
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
userNotificationsType userNotifications – matriz de retorno de conjuntos de parâmetros
Integer notificationsCount – número total de notificações para todas as páginas. Se nenhuma notificação for encontrada, retorna o código de erro 10

getVisitedGeozonesByPeriod – geodelimitações visitadas no período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
vehicleIdsType vehicleId – lista de IDs de veículos. Se ausente, todos os veículos disponíveis são usados para a solicitação
Valores de retorno
Boolean status – status da operação
String error – mensagem em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
visitedGeozone geozoneVisits – blocos de matrizes de parâmetros de cercas eletrônicas visitadas

getVehiclesParams – lista de parâmetros disponíveis para o usuário

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Vehicle vehicles – parâmetros de veículos que o usuário atual tem o direito de visualizar

signOut – encerramento de sessão

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
String sessionId – ID de sessão encerrada

getActiveNotificationRules – perfis de notificações ativas

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Valores de retorno
Boolean status – status da operação
String error – mensagem em caso de ocorrência de erro
rulesType rules – parâmetros para cada perfil de notificação

setDeviceIdToNotificationRules – atribuição de perfis de notificação para o veículo

Valores de entrada
String sessionId – ID de sessão obtida durante a autorização
String deviceId – ID do dispositivo
String deviceTypeId – identificador do tipo de dispositivo
rulesType rules – identificadores de perfis de notificação, necessários para atribuir veículos
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro

getFuelLevelsByTimeMoment – nível de combustível em um determinado momento

Valores de entrada
String sessionId – identificador de sessão obtido durante autorização
Unixtimestamp timeMoment – hora de início do intervalo (UTC), segundos
vehicleAndTankIdsType
vehicleAndTankIds – lista de IDs de veículos e tanques de combustível.
Na ausência da lista, a solicitação será executada para todos os veículos e tanques disponíveis para o usuário
Valores de retorno
Boolean status – status da operação
String error – mensagem em caso de ocorrência de erro
Unixtimestamp timeMoment – horário do momento (UTC), segundos
fuelData fuelDataSet – lista de parâmetros para cada veículo:
int vehicleId – identificador do veículo;
int tankNumber – número do tanque de combustível ;
fuelLevelsType fuelLevels – dados de nível de combustível;
activityPeriodsType activityPeriods – dados de funcionamento do motor;
ignitionOffListType ignitionOffList – dados de ignição desligada;
ignitionOnListType ignitionOnList – dados de ignição ligada;
llsFailurePeriodsType
llsFailurePeriods – dados sobre falhas de sensor de nível de combustível

getFuelLevelsByPeriod – nível de combustível no período de tempo

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos. Se a hora de término não for indicado, a hora de término = a hora do sistema do início do lado do servidor processamento de solicitação
VehicleAndTankIdsType
vehicleAndTankIds – lista de IDs de veículos e tanques de combustível.
Na ausência da lista, a solicitação será executada para todos os veículos e tanques disponíveis para o usuário
Int reduce – desbaste:
0 = opcional
1 = obrigatório
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
fuelData fuelDataSet – lista de parâmetros para cada veículo;
int vehicleId – identificador do veículo;
int tankNumber – número do tanque de combustível;
fuelLevelsType fuelLevels – dados de nível de combustível;
activityPeriodsType activityPeriods – dados de funcionamento do motor;
ignitionOffListType ignitionOffList – dados de ignição desligada;
ignitionOnListType ignitionOnList – dados de ignição ligada;
llsFailurePeriodsType
llsFailurePeriods – dados sobre falhas de sensor de nível de combustível

getSmoothedFuelLevelsByPeriod – níveis de combustível suavizados no período de tempo

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do objeto
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
vehicleAndTankIdsType vehicleAndTankIds – lista de IDs de veículos e tanques de combustível. Na ausência da lista, a solicitação será executada para todos os veículos e tanques disponíveis para o usuário
Int reduce – desbaste:
0 = opcional
1 = obrigatório
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
fuelData fuelDataSet – lista de parâmetros para cada veículo:
int vehicleId – identificador do veículo;
int tankNumber – número do tanque de combustível;
fuelLevelsType fuelLevels – dados de nível de combustível;
activityPeriodsType activityPeriods – dados de funcionamento do motor;
ignitionOffListType ignitionOffList – dados de ignição desligada;
ignitionOnListType ignitionOnList – dados de ignição ligada;
llsFailurePeriodsType
llsFailurePeriods – dados sobre falhas de sensor de nível de combustível

getRefuelingsAndDrainsByPeriod – operações de drenagem/reabastecimento operações no período de tempo

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
vehicleAndTankIdsType vehicleAndTankIds – lista de IDs de veículos e tanques de combustível. Na ausência da lista, a solicitação será executada para todos os veículos e tanques disponíveis para o usuário
Integer page – número da página solicitada com dados
Integer perPage – número de entradas por página; se não for predefinido, será considerado ilimitado
String sortname – campo necessário para organizar os parâmetros retornados
String sortorder – ordem de classificação:
asc – crescente
desc – decrescente
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
Integer entriesCounter – número total de entradas por período de tempo
RefuelingsAndDrainsType
RefuelingsAndDrains – lista de parâmetros para cada veículo

getVehiclesProfiles – perfis do veículo correspondentes aos identificadores do veículo

Valores de entrada
String sessionId – identificador de sessão obtido durante autorização
VehiclesType vehicles – lista de IDs de veículos
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Vehicles – lista de parâmetros para cada veículo

getCurrentObjectState – status atual do veículo

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do objeto
Valores de retorno
Boolean status – verdadeiro/falso. Verdadeiro no caso de operação bem-sucedida.
String error - mensagem de erro em caso de ocorrência de erro
String lastGPS – últimas coordenadas válidas. Contém valores de latitude e longitude, separados por ponto e vírgula
Integer lastGPSDir – direção de deslocamento, graus de 0 a 359
Double currentSpeed – velocidade atual em determinado momento, em km/h, precisão de 0,1 km/h
Double currentFuel – nível atual de combustível, em litros, precisão de 0,1 l
Boolean currentIgn – status de ignição. Verdadeiro, se a ignição está LIGADA
Boolean speedExceed – excesso de limite de velocidade. Verdadeiro no caso de limite de velocidade excedido
Integer lastGPSSat – número de satélites, com as últimas coordenadas válidas
Double currentInputValue – valor real de entrada universal. Atributos: Número inteiro – número de IU, nome da string – nome da IU

getReportData – relatório de equipamento auxiliar ao longo do período, TPMS, IQFreeze

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do objeto
Long timeBegin – hora de início do intervalo (UTC), segundos
Long timeEnd – hora de término do intervalo (UTC), segundos
String reportTemplateID – identificador de modelo de relatório no Omnicomm Online. Valores possíveis: addEquipment, TPMS, refState, refWork
Valores de retorno
Boolean status – verdadeiro/falso. Verdadeiro no caso de operação bem-sucedida
String error – mensagem de erro em caso de ocorrência de erro
ReportDataType reportData – matriz incluindo dados de relatório

getSEOnTime – tempo de funcionamento do equipamento auxiliar para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador do veículo/unidade
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) - hora de término do intervalo
Valores de retorno
Boolean status - verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Double sEOnTime (segundos) – tempo de funcionamento de equipamentos auxiliares para cada IU conectada. Atributos: Número inteiro – número de IU, nome da string – nome da IU

getStatisticsByPeriod – estatísticas para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante autorização
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos. Se não definido, a hora de término = hora da execução da solicitação pelo servidor.
int objectType – tipo de objeto:
0=veículo;
1=motorista;
Se o tipo não existir, retorna o código de erro 12.
objectIdsType objectIds – matriz do tipo objectIdsType, contendo a lista de parâmetros objectId do tipo inteiro. Caso não exista, a consulta é executada para todos o objectId do tipo correspondente, disponíveis para o usuário.
requiredStatParamsType requiredStatParams – lista dos subgrupos necessárias dos parâmetros do relatório 'Estatísticas'. Se a lista estiver vazia, retorna todos os subgrupos com todos os parâmetros
Valores de retorno
movingAndWorkingParamsType movementAndWorkingParams – subgrupo dos parâmetros de deslocamento o e operação de veículos. Se a lista estiver vazia, retorna todos os parâmetros do subgrupo, caso contrário, retorna apenas os parâmetros enumerados. Se o subgrupo não for transmitido, não retorna o subgrupo todo.
fuelParamsType fuelParams – subgrupo de parâmetros para combustível, drenagem e reabastecimentos. Se a lista estiver vazia, retorna todos os parâmetros do subgrupo, caso contrário, retorna apenas os parâmetros enumerados. Se o subgrupo não for transmitido, não retorna o subgrupo todo.
optionalEquipmentParamsType optionalEquipmentParams – subgrupo de parâmetros do equipamento auxiliar. Se a lista estiver vazia, retorna todos os parâmetros do subgrupo, caso contrário, retorna apenas os parâmetros enumerados. Se o subgrupo não for transmitido, não retorna o subgrupo todo.
CANDataParamsType CANDataParams – subgrupo dos parâmetros CAN. Se a lista estiver vazia, retorna todos os parâmetros do subgrupo, caso contrário, retorna apenas os parâmetros enumerados. Se o subgrupo não for transmitido, não retorna o subgrupo todo.
addDataParamsType addDataParams – subgrupo de parâmetros estatísticos adicionais: TPMS, iQFreeze etc.

getTracksByPeriod – rastreamento do veículo para o período

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos. Se a hora de término não for indicado, a hora de término = a hora do sistema do início do lado do servidor processamento de solicitação
VehiclesType vehicles – lista de ID de veículos
Int reduce – desbaste:
0 = opcional
1 = obrigatório
Valores de retorno
Boolean status – status da operação
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin – hora de início do intervalo (UTC), segundos
Unixtimestamp timeEnd – hora de término do intervalo (UTC), segundos
trackDataSetType trackDataSet – parâmetros de rastreamento para cada veículo:
trackPoint – parâmetros do ponto de rastreamento por um veículo
unixtimestamp timestamp – hora do evento quando as coordenadas foram fixadas
Integer latitude – latitude com precisão 0,0000001 grau
Integer longitude – longitude com precisão de 0,0000001 grau
Integer direction – direção, graus
Integer sattelitesCount – número de satélites
Double speed (km/hora) – velocidade
Long timeStamp (segundos) – hora do evento. (UTC)

getTrack – rastreamento

Valores de entrada
String sessionId – identificador de sessão obtido durante a autorização
Integer objectId – identificador de objeto
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Valores de retorno
Boolean status – verdadeiro/falso, verdadeiro em caso de operação bem-sucedida
String error – mensagem de erro em caso de ocorrência de erro
Unixtimestamp timeBegin (segundos) – hora de início do intervalo
Unixtimestamp timeEnd (segundos) – hora de término do intervalo
Dataset trackEvents – matriz de pontos de rastreamento:
String gpsPos – coordenadas do evento. Contém valores de latitude e longitude, separados por ponto e vírgula
Integer gpsDir – direção de movimento, graus de 0 a 359
Integer sattelitesCount – número de satélites
Double speed – velocidade, em km/hora com precisão de até 0,1 km/hora
Unixtimestamp timeStamp – ponto de data e hora

Lista de métodos da API REST

/api/service/geozones/geozones GET – aquisição de dados sobre cerca eletrônica

As cercas eletrônicas de usuários são divididas em páginas. É possível especificar a página desejada e o número de cercas eletrônicas por página no método de solicitação.

Valores de entrada
String Bearer {SessionID} or JWT {JWT} – identificador de sessão, recebido durante a autorização. Por exemplo, para SessionID: Portador 611ed1554ced2e10d13938bbd18482b060cb20f1
Integer page – o número da página com cercas eletrônicas do usuário. Se o valor não for especificado, retorna a primeira página
Integer pageSize – número de cercas eletrônicas na página. Valores possíveis: 1 a 50. Padrão valor: 20
Valores de retorno
Integer total – número total de cercas eletrônicas
Integer page – o número da página atual com cercas eletrônicas do usuário
Integer pageSize – número de cercas eletrônicas na página
Dataset rows – lista de cercas eletrônicas:
String name – nome da cerca eletrônica
Integer id – geofence identifier
Integer rootGroupId – grupo raiz da cerca eletrônica
Integer geozoneTypeId – – identificador de tipo de cerca eletrônica
string geozoneTypeName – número de tipo de cerca eletrônica
Number radius – raio de uma cerca eletrônica do tipo “círculo”
Integer geometryTypeId – identificador da forma da cerca eletrônica Um polígono é usado para uma cerca eletrônica do tipo “círculo”
String geometryTypeName – forma da cerca eletrônica
Integer lineWidth – largura de uma cerca eletrônica do tipo de “linha”
Integer status – – identificador de status (ativo/inativo)
String statusName – status
String uuid – identificador de cerca eletrônica uuid
Number latitude – latitude do ponto do centro geográfico de uma cerca eletrônica do tipo “círculo”
Number longitude – longitude do ponto do centro geográfico de uma cerca eletrônica do tipo do “círculo”
Integer countPoints – número de pontos em uma cerca eletrônica
Dataset points – pontos de uma cerca eletrônica:
Integer pointId – identificador do ponto
Number latitude – latitude
Number longitude – longitude

/api/service/geozones/geozone-groups GET – aquisição de dados sobre todos os grupos de usuários da cerca eletrônica

Valores de entrada
String Bearer {SessionID} or JWT {JWT} – identificador de sessão, recebido durante a autorização. Por exemplo, para SessionID: Portador 611ed1554ced2e10d13938bbd18482b060cb20f1
Valores de retorno
geozoneIds – identificadores de cercas eletrônicas que não fazem parte de qualquer grupo
Integer geozoneIds – identificador de cerca eletrônica
Dataset groups – lista de grupos de cercas eletrônicas:
Integer Id – identificador do grupo
Integer parentGroupId – identificador do grupo matriz
String name – nome do grupo
geozoneIds – identificadores de cercas eletrônicas que fazem parte de qualquer grupo
Integer geozoneIds – identificador de cerca eletrônica

Erros

Lista de erros retornados:

0: No errors – há sem erros

1: Signing in failed – Login/senha digitados incorretamente

2: Authorization required – autorização é necessária para acessar os dados

3: Dead session number – sessão expirou, re-autorização é necessária

4: Bad interval – intervalo incorreto inserido

5: Bad object – não há nenhum objeto com esse identificador

6: Admin login – alguém está tentando fazer login como usuário Administrador

7: Unusable object – o valor não pode ser calculado para o objeto com esse identificador

8: Bad event type – não há nenhum objeto com esse identificador

9: Access denied – sem autorização para acessar o objeto

10: Data not found – sem dados para os valores de entrada correspondentes

11: Blocked interval – o intervalo solicitado contém períodos de bloqueio de dados

12: Bad object type – o tipo de objeto especificado não existe

13: Invalid format – o formato está incorreto

14: Undefined error – o erro é não especificado

15: 404 – página não encontrada

Exemplo de consumo do Webservice

Importação de interfaces

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

Código Java:

É necessário alterar as strings “user” e “pass” para os valores reais.

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()); 
        }

    }
}

Tipos de eventos

Evento tipo número Significado Valores de parâmetro, comentários
1 Início do reabastecimento (para caminhões-tanque de reabastecimento – abastecimento) Valor de reabastecimento, precisão de 0,1 litro
2 Fim do reabastecimento (para caminhões-tanque de reabastecimento – abastecimento) Valor de reabastecimento, precisão de 0,1 litro
3 Início de drenagem Valor de drenagem, precisão de 0,1 litro
4 Término da drenagem Valor de drenagem, precisão de 0,1 litro
5 Ignição LIG Tempo desde o último desligamento da ignição, minutos
6 Ignição DESL
7 Fonte de alimentação externa LIG
8 Bateria LIG
9 Autorização do motorista Código chave iButton, em HEX
10 Transição para roaming
11 Saída de roaming
12 Excesso de velocidade instantâneo Valor máximo de velocidade, precisão de 0,1 km/h
13 Tempo de ociosidade
14 Início de excesso de velocidade
15 Início de grupos de transação (para reabastecimento de caminhões-tanque) Volume de combustível antes do início de grupos de transações, precisão de 0,1 litro
16 Término de grupos de transação (para reabastecimento de caminhões-tanque) Volume de combustível após encerramento dos grupos de transações, precisão de 0,1 litro
17 Início do abastecimento durante grupos de transações (para reabastecimento de caminhões-tanque)
18 Término do abastecimento durante grupos de transações (para reabastecimento de caminhões-tanque)
19 Início de drenagem durante grupos de transações (para reabastecimento de caminhões-tanque)
20 Término de drenagem durante grupos de transações (para reabastecimento de caminhões-tanque)
21 Conexão estabelecida
22 Equipamento adicional LIG
23 Equipamento adicional DESL
24 Equipamento auxiliar excedendo limites máx
25 Voltar aos valores normais de equipamento auxiliares valores normais
31 Pressionamento do botão de pânico
32 Sobrecarga de equipamento auxiliar
33 LIGADO
34 RPM excedido instantâneo
35 Entrada em cerca eletrônica
36 Saída de cerca eletrônica
38 DESLIGADO
42 Início da parada
43 Término da parada
44 Início da aceleração
45 Término da aceleração
46 Entrada digital LIG
47 Entrada digital DESL
48 Aceleração instantânea
49 Motorista desconhecido
52 Adulteração de dispositivo
53 Autorização de motorista encerrada
54 iButton aplicado
55 Registro de motorista excluído