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 sem 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 |
getEngineStatisticsByPeriod – estatísticas de operação do motor durante um período
| Valores de entrada |
|---|
| String sessionId – identificador de sessão obtido durante a autorização Integer vehicleId – identificador do veículo Unixtimestamp timeBegin (segundos) – momento de início do intervalo Unixtimestamp timeEnd (segundos) – momento de término do intervalo |
| Valores de retorno |
|---|
| Boolean status – true/false Retorna 'true' (verdadeiro) se a operação foi bem sucedida String error – texto da mensagem de erro que aparece quando se dá o erro Unixtimestamp timeBegin (segundos) – momento de início do intervalo Unixtimestamp timeEnd (segundos) – momento de término do intervalo Unixtimestamp lastDataTimestamp (segundos) – registro de hora dos últimos dados processados (UTC) Unixtimestamp operationStartDate (segundos) – momento de início da operação para o período (UTC) Unixtimestamp operationEndDate (segundos) – momento de término da operação para o período (UTC) Integer operationTime (segundos) – tempo de operação para o período Integer engineOffTime (segundos) – duração com o motor desligado para o período Integer engineOnTime (segundos) – duração com o motor ligado para o período Integer engineIdlingTime (segundos) – duração da operação do motor em marcha lenta para o período Integer engineOperationTimeNormalSpeed (segundos) – duração da operação do motor sob carga normal para o período Integer engineOperationTimeMaxSpeed (segundos) – duração da operação do motor sob carga máxima para o período Integer engineLoadTime (segundos) – duração da operação do motor sob carga para o período Integer dataAbsenceTime (segundos) – duração da ausência de dados para o período |
getShiftDataByPeriod – informação sobre os turnos
| Valores de entrada |
|---|
| String sessionId – identificador de sessão obtido durante a autorização Unixtimestamp timeBegin (segundos) – hora de início do turno agendada Unixtimestamp timeEnd (segundos) – hora de término do turno agendada Integer devBeforeBegin (segundos) – adiantamento permitido da hora de início do turno agendada Integer devAfterBegin (segundos) – atraso permitido da hora de início do turno agendada Integer devBeforeEnd (segundos) – adiantamento permitido da hora de término do turno agendada Integer devAfterEnd (segundos) – atraso permitido da hora de término do turno agendada Integer vehicleId – identificador do veículo |
| Valores de retorno |
|---|
| Boolean status – true/false Retorna 'true' (verdadeiro) se a operação foi bem sucedida String error – texto da mensagem de erro que aparece quando se dá o erro Integer vehicleId – identificador do veículo Integer vehicleType – tipo de veículo (0 - carro, 1 - caminhão-tanque) shiftData: Unixtimestamp pointDate (segundos) – momento efetivo do início/término do turno (UTC) |
getIntervalsInfo – informação dividida em intervalos
| Valores de entrada |
|---|
| String sessionId – identificador de sessão obtido durante a autorização Integer vehicleId – identificador do veículo Unixtimestamp timeBegin (segundos) – momento de início do intervalo Unixtimestamp timeEnd (segundos) – momento de término do intervalo Boolean partsFlag – divisão em partes (true or false) Integer interval (min) – duração do intervalo Boolean geocodingFlag – resolução do endereço com base nas coordenadas (true or false) Boolean additionalTankFlag – retorna um conjunto de dados sobre o nível de combustível no tanque adicional (true or false) |
| Valores de retorno |
|---|
| Boolean status – true/false Retorna 'true' (verdadeiro) se a operação foi bem sucedida Integer errorCode – código de erro. Códigos de erro possíveis: 2: Authorization required - é necessária autorização para acessar os dados 3: Dead session number – a sessão expirou, é necessário autorizar novamente 4: Bad interval – inserido um intervalo incorreto 5: Bad object – não há nenhum veículo com esse identificador 7: Unusable object– o valor não pode ser calculado para um objeto com esse identificador. 9: Access denied – sem direitos de acesso ao objeto 10: Data not found – não há dados para os valores de entrada correspondentes (sem eventos de dados brutos para o [período de solicitação + um evento antes do início do período]) 11:Blocked interval – o intervalo solicitado contém períodos de bloqueio de dados 13: Invalid format – o formato está incorreto 14: Undefined error – o erro não foi especificado 19: Too many intervals: current N, allowed M - o número de intervalos por período (N) excede o limite (M) String erorrDescription – opcional Integer vehicleId – identificador do veículo Integer vehicleType – tipo de veículo (0 - carro, 1 - caminhão-tanque) Integer tanksNumber – número de tanques de combustível Integer numberOfIntervals – número de intervalos no período solicitado periodData – dados definidos para o período solicitado intervalsData – dados para o intervalo: Integer intervalNumber – número da sequência de intervalo |
