Escolar Documentos
Profissional Documentos
Cultura Documentos
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 1 de 77
Código
Integração SIGhRA
Versão 1.7.3
Data 03/02/2023
Documento Documentacao_Web_Service_SIGhRA_v01.07.03.pdf
Índice
1 Controle de Revisões ............................................................................................................. 4
2 Introdução ............................................................................................................................... 5
3 Métodos disponíveis............................................................................................................... 6
3.8 obterMensagens.............................................................................................................. 22
3.23 enviarConfiguracoesMensagemPre................................................................................. 61
3.27 obterVersao..................................................................................................................... 72
4 Tabelas .................................................................................................................................. 73
5.4 GrupoArea....................................................................................................................... 76
1 Controle de Revisões
2 Introdução
Este documento tem como objetivo o detalhamento técnico das interações com o WebService
SIGhRA para integração de sistemas. Trata-se de web service desenvolvido utilizando-se de
protocolo SOAP e XML para troca de informações.
3 Métodos disponíveis
Campo Descrição
obterUltimaPosicao Obtém a última posição de todos os veículos da base.
obterPosicoes Histórico de posições utilizando posição inicial (id) como critério.
obterPosicoesPeriodo Histórico de posições informando período como critério.
obterPosicoesCriterio Histórico de posições informando uma combinação de critérios de busca.
obterMacros Histórico de macros utilizando macro inicial (id) como critério.
obterMacrosPeriodo Histórico de macros informando período como critério.
obterMacrosCriterio Histórico de macros informando uma combinação de critérios de busca.
obterMensagens Histórico de mensagens informando mensagem inicial (id) como critério.
obterMensagensPeriodo Histórico de mensagens informando período como critério.
obterMensagensCriterio Histórico de mensagens informando uma combinação de critérios de busca.
enviarMensagem Envio de mensagem para o veículo.
obterInfracoes Histórico de infrações utilizando infração inicial (id) como critério.
obterInfracoesPeriodo Histórico de infrações informando período como critério.
obterInfracoesCriterio Histórico de infrações informando uma combinação de critérios de busca.
obterTelemetria Histórico de relatórios de telemetria utilizando relatório inicial (id)
como critério.
obterTelemetriaPeriodo Histórico de relatórios de telemetria informando período como critério.
obterTelemetriaCriterio Histórico de relatórios de telemetria informando
uma combinação de critérios de busca.
enviarMotoristas Envia informação de motoristas para o veículo.
desativarMotoristas Desativa cadastro de motoristas.
ativarMotoristas Reativa cadastro dos motoristas.
enviarConfiguracoesMacro Envia grupos de macros para os veículos selecionados.
enviarConfiguracoesArea Envio de grupos de áreas para os veículos.
enviarConfiguracoesMensagemPre Envio de grupos de mensagens pré-formatadas para os veículos.
enviarComandoTelefonico Solicitação de contrassenha para execução de comando pelo motorista.
enviarComando Envio de comando para um veículo.
enviarConfiguracoesSensor Habilitação/Desabilitação de sensores para os veículos.
obterVersao Retorna a versão do WebService.
3.1 obterUltimaPosicao
Método para obter a última posição dos veículos ativos cadastrados na base.
3.1.3 Retorno
Nome Tipo Descrição
posicao List<Posicao> Lista contendo 0 ou mais posições.
codigoRetorno int 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.2 obterPosicoes
3.2.1 Descrição
Método para obter histórico de posições a partir do ponteiro informado (id inicial) nos
parâmetros de entrada.
Retorno limitado a 1000 posições. Para obter as posições seguintes, o método deve ser
chamado novamente utilizando o último id obtido na chamada anterior.
3.2.4 Retorno
Nome Tipo Descrição
posicao List<Posicao> Lista contendo 0 ou mais posições.
codigoRetorno int 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
<cidade>PAULINIA</cidade>
<pontoReferencia>PAULINIA</pontoReferencia>
<curso>302</curso>
<dataPosicao>2019-04-13T12:39:59-03:00</dataPosicao>
<dataRecepcao>2019-04-13T12:40:08-03:00</dataRecepcao>
<estado>SP</estado>
<id>7042006902089</id>
<idVeiculo>99999</idVeiculo>
<ignicao>true</ignicao>
<latitude>-22.7582</latitude>
<logradouro>Não foi possível definir</logradouro>
<longitude>-47.1059</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<placa>AAA9999</placa>
<sequencial>49676</sequencial>
<velocidade>0</velocidade>
<hodometro>104388</hodometro>
<numeroSat>11</numeroSat>
<dop>0</dop>
<tensaoBateria>25595</tensaoBateria>
<horimetro>1501904</horimetro>
<memoria>false</memoria>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>26355</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<sensorAtuador>
<descricao>Porta Motorista</descricao>
<sigla>PM</sigla>
<descricaoStatus>Porta de Motorista Fechada</descricaoStatus>
<status>false</status>
<tipo>Sensor</tipo>
</sensorAtuador>
</posicao>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Consulta executada com sucesso</mensagemRetorno>
</return>
</w:obterPosicoesResponse>
</S:Body>
</S:Envelope>
id Long Id da posição
sequencial Integer Número sequencial da posição gerado pelo equipamento
placa String Placa do veículo
idVeiculo Integer Id do veículo
frota String Identificação do veículo na Frota
dataRecepcao Date Data/Hora da recepção da posição no servidor
idEvento Integer Código do evento. Verificar tabela 4.3.
dataPosicao Date Data/Hora da geração da posição GPS
latitude Double Latitude do veículo
longitude Double Longitude do veículo
curso Integer Curso (direção) do Veículo (em graus)
ignição Boolean Indica se a ignição estava ligada no momento da geração da
posição
velocidade Integer Velocidade do veículo
hodometro Integer Hodômetro do Veículo (em metros)
meioComunicacao String Meio de comunicação utilizado no envio pelo equipamento
(GPRS ou Satelital)
alarme Boolean Indica se o equipamento estava em alarme
cidade String Cidade na qual o veículo se encontra
estado String Estado no qual o veículo se encontra
logradouro String Logradouro mais próximo
pontoReferencia String Ponto de referência mais próximo
numeroSat Integer Número de satélites utilizados para a obtenção da posição GPS
dop Integer DOP da última posição GPS
tensaoBateria Integer Tensão da bateria (em mV)
horimetro Integer Horímetro do veículo
memoria Boolean Indica se posição foi obtida da memória (histórico) ou se é
online.
motorista Motorista Motorista logado no veículo. Verificar Tipo 5.2.
statusSensor SensorAtuador Status dos Sensores/Atuadores
3.3 obterPosicoesPeriodo
3.3.1 Descrição
Método para obter histórico de posições no período informado nos parâmetros de entrada.
Retorno limitado a 1000 posições. Para obter as posições seguintes, o método deve ser
chamado novamente utilizando novo período.
3.3.4 Retorno
Igual ao método obterPosicoes.
3.4 obterPosicoesCriterio
3.4.1 Descrição
Método para obter histórico de posições utilizando uma combinação de critérios de entrada.
Retorno limitado a 1000 posições. Para obter as posições seguintes, o método deve ser
chamado novamente utilizando novos parâmetros.
3.4.3 RequisicaoPosicao
Nome Tipo Obr. Descrição
ultimaPosicao Boolean N Sinaliza se devem ser retornadas apenas as últimas posições dos
veículos. Caso utilizado, serão ignorados os critérios de id e de
data. Padrão: false.
id Long N Ponteiro (id inicial) para o retorno das posições. Quando o valor
informado for igual a 0 (zero), serão consideradas as posições do
dia atual. Será priorizado em relação aos critérios de data.
dataPosicaoInicio Date N Data inicial (GPS) do período no formato “aaaa-mm-dd’T’
HH:mm:ss”. Ex: 2020-10-01T00:00:00.
dataPosicaoFim Date N Data final (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”. Ex: 2020-10-01T01:00:00.
dataRecepcaoInicio Date N Data inicial (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataRecepcaoFim Date N Data final (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
status Boolean N Sinaliza se devem ser retornadas informações de sensores e
atuadores no retorno. Padrão: true.
motorista Boolean N Sinaliza se devem ser retornadas informações de motorista no
retorno. Padrão: true.
</requisicao>
</ws:obterPosicoesCriterio>
</soapenv:Body>
</soapenv:Envelope>
3.4.5 Retorno
Igual ao método obterPosicoes.
3.5 obterMacros
3.5.1 Descrição
Método para obter histórico de macros a partir do ponteiro informado nos parâmetros de
entrada.
Retorno limitado a 1000 macros. Para obter as macros seguintes, o método deve ser
chamado novamente utilizando o último id obtido na chamada anterior.
3.5.4 Retorno
Nome Tipo Descrição
macro List<Macro> Lista contendo 0 ou mais macros.
codigoRetorno int 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
<curso>72</curso>
<dataMacro>2019-07-11T23:59:58-03:00</dataMacro>
<dataRecepcao>2019-07-12T00:00:05-03:00</dataRecepcao>
<estado>SÃO PAULO</estado>
<formulario>1-INICIO DE JORNADA LOGIN:[999 ] SENHA:[*****]</formulario>
<id>18746262</id>
<idVeiculo>99999</idVeiculo>
<ignicao>false</ignicao>
<latitude>-23.823</latitude>
<logradouro>Estrada Vicinal José Waldemar Mazzer</logradouro>
<longitude>-47.7069</longitude>
<numeroSat>11</numeroSat>
<dop>0</dop>
<macro>INICIO JORNADA</macro>
<meioComunicacao>GPRS</meioComunicacao>
<numeroMacro>1</numeroMacro>
<placa>AAA-9999</placa>
<sequencial>34640</sequencial>
<tipoMacro>Início de Jornada</tipoMacro>
<velocidade>0</velocidade>
<hodometro>4646502</hodometro>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>26355</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
</macro>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Consulta executada com sucesso</mensagemRetorno>
</return>
</w:obterMacrosResponse>
</S:Body>
</S:Envelope>
3.6 obterMacrosPeriodo
3.6.1 Descrição
Método para obter histórico de macros no período informado nos parâmetros de entrada.
Retorno limitado a 1000 macros. Para obter as macros seguintes, o método deve ser
chamado novamente utilizando novo período.
3.6.4 Retorno
Igual ao método obterMacros.
3.7 obterMacrosCriterio
3.7.1 Descrição
Método para obter histórico de macros utilizando uma combinação de critérios de entrada.
Retorno limitado a 1000 macros. Para obter as macros seguintes, o método deve ser
chamado novamente utilizando novos parâmetros.
3.7.3 RequisicaoMacro
Nome Tipo Obr. Descrição
id Long N Ponteiro (id inicial) para o retorno das macros. Quando o
valor informado for igual a 0 (zero), serão consideradas
as macros do dia atual. Será priorizado em relação aos
critérios de data.
dataPosicaoInicio Date N Data inicial (GPS) do período no formato “aaaa-mm-dd’T’
HH:mm:ss”. Ex: 2020-10-01T00:00:00.
dataPosicaoFim Date N Data final (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”. Ex: 2020-10-01T01:00:00.
dataRecepcaoInicio Date N Data inicial (Recepção) do período no formato “aaaa-
mm-dd’T’HH:mm:ss”.
dataRecepcaoFim Date N Data final (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
3.7.5 Retorno
Igual ao método obterMacros.
3.8 obterMensagens
3.8.1 Descrição
Método para obter histórico de mensagens a partir do ponteiro informado nos parâmetros de
entrada.
Retorno limitado a 1000 mensagens. Para obter as mensagens seguintes, o método deve ser
chamado novamente utilizando o último id obtido na chamada anterior.
3.8.4 Retorno
Nome Tipo Descrição
mensagem List<Mensagem> Lista contendo 0 ou mais mensagens.
codigoRetorno int 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
<dataMensagem>2019-07-11T23:59:53-03:00</dataMensagem>
<dataRecepcao>2019-07-12T00:00:09-03:00</dataRecepcao>
<estado>PARANÁ</estado>
<id>5031102</id>
<idVeiculo>99999</idVeiculo>
<ignicao>false</ignicao>
<latitude>-25.4295</latitude>
<logradouro>AC P/ROD BR-277</logradouro>
<longitude>-49.3652</longitude>
<numeroSat>11</numeroSat>
<dop>0</dop>
<meioComunicacao>GPRS</meioComunicacao>
<mensagem>OK LIBERADO SMP: 9999999 - 11/07/2019 23:59:56</mensagem>
<origem>V</origem>
<idEvento>11024</idEvento>
<placa>AAA-9999</placa>
<sequencial>49427</sequencial>
<velocidade>39</velocidade>
<hodometro>4646502</hodometro>
</mensagem>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Consulta executada com sucesso</mensagemRetorno>
</return>
</w:obterMensagensResponse>
</S:Body>
</S:Envelope>
3.9 obterMensagensPeriodo
3.9.1 Descrição
Método para obter histórico de mensagens no período informado nos parâmetros de entrada.
Retorno limitado a 1000 mensagens. Para obter as mensagens seguintes, o método deve ser
chamado novamente utilizando novo período.
3.9.4 Retorno
Igual ao método obterMensagens.
3.10 obterMensagensCriterio
3.10.1 Descrição
Método para obter histórico de mensagens utilizando uma combinação de critérios de
entrada.
Retorno limitado a 1000 mensagens. Para obter as mensagensseguintes, o método deve ser
chamado novamente utilizando novos parâmetros.
3.10.3 RequisicaoMensagem
Nome Tipo Obr. Descrição
id Long N Ponteiro (id inicial) para o retorno das mensagens. Quando o
valor informado for igual a 0 (zero), serão consideradas as
mensagens do dia atual. Será priorizado em relação aos
critérios de data.
dataPosicaoInicio Date N Data inicial (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”. Ex: 2020-10-01T00:00:00.
dataPosicaoFim Date N Data final (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”. Ex: 2020-10-01T01:00:00.
dataRecepcaoInicio Date N Data inicial (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataRecepcaoFim Date N Data final (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
3.10.5 Retorno
Igual ao método obterMensagens.
3.11 enviarMensagem
3.11.1 Descrição
Envio de mensagem para o veículo.
3.11.4 Retorno
Nome Tipo Descrição
codigoRetorno Integer 0 – Envio solicitado com sucesso
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.12 obterInfracoes
3.12.1 Descrição
Método para obter histórico de infrações a partir do ponteiro informado nos parâmetros de
entrada.
Retorno limitado a 1000 infrações. Para obter as infrações seguintes, o método deve ser
chamado novamente utilizando o último id obtido na chamada anterior.
3.12.4 Retorno
Nome Tipo Descrição
infracao List<Infracao> Lista contendo 0 ou mais infrações.
codigoRetorno Integer 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
<infracao>
<cidade>SÃO BERNARDO DO CAMPO</cidade>
<dataInfracao>2020-09-13T23:55:05-03:00</dataInfracao>
<dataRecepcao>2020-09-14T00:00:05-03:00</dataRecepcao>
<duracao>17</duracao>
<estado>SÃO PAULO</estado>
<id>113050581</id>
<idVeiculo>17717</idVeiculo>
<infracao>INFRACAO_VELOCIDADE_MAXIMA</infracao>
<latitude>-23.8095</latitude>
<logradouro>Rodovia dos Imigrantes</logradouro>
<longitude>-46.587</longitude>
<numeroSat>11</numeroSat>
<dop>0</dop>
<meioComunicacao>GPRS</meioComunicacao>
<placa>AAA-9999</placa>
<sequencial>61699</sequencial>
<velocidadeLimite>80</velocidadeLimite>
<velocidadeMaxima>85</velocidadeMaxima>
<velocidadeMedia>83</velocidadeMedia>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>99999</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
</infracao>
<infracao>
<cidade>GLORINHA</cidade>
<dataInfracao>2020-09-14T00:08:32-03:00</dataInfracao>
<dataRecepcao>2020-09-14T00:08:42-03:00</dataRecepcao>
<duracao>1</duracao>
<estado>RIO GRANDE DO SUL</estado>
<id>113051275</id>
<idVeiculo>99999</idVeiculo>
<infracao>INFRACAO_VELOCIDADE_MAXIMA_CHUVA</infracao>
<latitude>-29.8895</latitude>
<logradouro>Freeway</logradouro>
<longitude>-50.6865</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>99999</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<placa>AAA-9999</placa>
<sequencial>23319</sequencial>
<velocidadeLimite>60</velocidadeLimite>
<velocidadeMaxima>75</velocidadeMaxima>
<velocidadeMedia>75</velocidadeMedia>
</infracao>
<infracao>
<dataInfracao>2020-09-13T22:45:55-03:00</dataInfracao>
<dataRecepcao>2020-09-14T00:08:46-03:00</dataRecepcao>
<duracao>1</duracao>
<id>113051288</id>
<idVeiculo>99999</idVeiculo>
<infracao>INFRACAO_ROTACAO</infracao>
<latitude>-8.55746</latitude>
<logradouro>Não foi possível definir</logradouro>
<longitude>-40.9943</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<placa>AAA-9999</placa>
<rotacaoLimite>2600</rotacaoLimite>
<rotacaoMaxima>2645</rotacaoMaxima>
<sequencial>45768</sequencial>
<velocidadeMedia>78</velocidadeMedia>
</infracao>
<infracao>
<cidade>ITU</cidade>
<dataInfracao>2020-09-14T00:07:43-03:00</dataInfracao>
<dataRecepcao>2020-09-14T00:07:57-03:00</dataRecepcao>
<duracao>6</duracao>
<estado>SÃO PAULO</estado>
<id>113051200</id>
<idVeiculo>99999</idVeiculo>
<infracao>INFRACAO_BANGUELA</infracao>
<latitude>-23.4056</latitude>
<logradouro>Rodovia Presidente Castelo Branco</logradouro>
<longitude>-47.3067</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>999999</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<placa>AAA-9999</placa>
<sequencial>810</sequencial>
<velocidadeMaxima>49</velocidadeMaxima>
<velocidadeMedia>48</velocidadeMedia>
</infracao>
<infracao>
<dataInfracao>2020-09-14T00:07:58-03:00</dataInfracao>
<dataRecepcao>2020-09-14T00:08:33-03:00</dataRecepcao>
<desaceleracao>12</desaceleracao>
<desaceleracaoLimite>12</desaceleracaoLimite>
<id>113051267</id>
<idVeiculo>999999</idVeiculo>
<infracao>INFRACAO_FRENAGEM_BRUSCA</infracao>
<latitude>-23.8563</latitude>
<logradouro>Rodovia Cônego Domênico Rangoni</logradouro>
<longitude>-46.369</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<cpf>99999999999</cpf>
<idCliente>99999</idCliente>
<login>99999</login>
<nome>NOME DO MOTORISTA</nome>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<placa>AAA-9999</placa>
<sequencial>2150</sequencial>
<velocidadeInicial>63</velocidadeInicial>
</infracao>
<infracao>
<cidade>RIO DE JANEIRO</cidade>
<dataInfracao>2021-07-05T13:52:46-03:00</dataInfracao>
<dataRecepcao>2021-07-05T13:52:56-03:00</dataRecepcao>
<dop>0</dop>
<duracao>1</duracao>
<estado>RJ</estado>
<forca>0.668</forca>
<forcaLimite>0.448</forcaLimite>
<id>167427944</id>
<idVeiculo>999999</idVeiculo>
<latitude>-22.9409</latitude>
<logradouro>Estrada do Gabinal</logradouro>
<longitude>-43.3449</longitude>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<nome>NOME DO MOTORISTA</nome>
<login>99999</login>
<cpf>99999999999</cpf>
<idCliente>9999999</idCliente>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<numeroSat>8</numeroSat>
<placa>AAA-9999</placa>
<pontoReferencia>RIO DE JANEIRO</pontoReferencia>
<sequencial>2285</sequencial>
<tipoInfracao>INFRACAO_GUINADA_BRUSCA_ESQUERDA</tipoInfracao>
<velocidadeInicial>31</velocidadeInicial>
</infracao>
<codigoRetorno>1</codigoRetorno>
<mensagemRetorno>Consulta executada com sucesso</mensagemRetorno>
</return>
</w:obterInfracoesResponse>
</S:Body>
</S:Envelope>
INFRACAO_BANGUELA
INFRACAO_ROTACAO
INFRACAO_FRENAGEM_BRUSCA
INFRACAO_GUINADA_BRUSCA_DIREITA
INFRACAO_GUINADA_BRUSCA_ESQUERDA
INFRACAO_ACELERACAO_LONGITUDINAL
INFRACAO_DESACELERACAO_LONGITUDINAL
INFRACAO_VELOCIDADE_AREA_ROTOGRAMA
ALARME_TEMPO_MINIMO_REFEICAO
ALERTA_TEMPO_DIRECAO_EXCEDIDO
ALARME_TEMPO_DIRECAO_EXCEDIDO
ALERTA_TEMPO_JORNADA_EXCEDIDO
ALARME_TEMPO_JORNADA_EXCEDIDO
ALERTA_TEMPO_RESERVA_EXCEDIDO
ALARME_TEMPO_RESERVA_EXCEDIDO
ALERTA_TEMPO_HORA_EXTRA_EXCEDIDO
ALARME_TEMPO_HORA_EXTRA_EXCEDIDO
ALERTA_DIRECAO_HORARIO_NAO_PERMITIDO
ALARME_DIRECAO_HORARIO_NAO_PERMITIDO
ALERTA_REFEICAO_NAO_REALIZADA
ALARME_REFEICAO_NAO_REALIZADA
ALARME_TEMPO_JORNADA_DESCANSO_MIN
ALERTA_TEMPO_REFEICAO_TOTAL
motorista Motorista Motorista logado no veículo. Verificar Tipo 5.2.
velocidadeLimite Integer Velocidade limite configurada no equipamento (km/h).
Disponível para tipo(s):
INFRACAO_VELOCIDADE_MAXIMA
INFRACAO_VELOCIDADE_MAXIMA_CHUVA
INFRACAO_VELOCIDADE_AREA_ROTOGRAMA
velocidadeMaxima Integer Velocidade máxima aferida durante a infração (km/h).
Disponível para tipo(s):
INFRACAO_VELOCIDADE_MAXIMA
INFRACAO_VELOCIDADE_MAXIMA_CHUVA
INFRACAO_BANGUELA
INFRACAO_VELOCIDADE_AREA_ROTOGRAMA
duracao Integer Duração da infração em segundos.
Disponível para tipo(s):
INFRACAO_VELOCIDADE_MAXIMA
INFRACAO_VELOCIDADE_MAXIMA_CHUVA
INFRACAO_BANGUELA
INFRACAO_ROTACAO
INFRACAO_GUINADA_BRUSCA_DIREITA
INFRACAO_GUINADA_BRUSCA_ESQUERDA
INFRACAO_ACELERACAO_LONGITUDINAL
INFRACAO_DESACELERACAO_LONGITUDINAL
INFRACAO_VELOCIDADE_AREA_ROTOGRAMA
desaceleracaoLimite Integer Desaceleração limite configurada no equipamento (km/h/s).
3.13 obterInfracoesPeriodo
3.13.1 Descrição
Método para obter histórico de infrações no período informado nos parâmetros de entrada.
Retorno limitado a 1000 infrações. Para obter as infrações seguintes, o método deve ser
chamado novamente utilizando novo período.
3.13.4 Retorno
Igual ao método obterInfracoes.
3.14 obterInfracoesCriterio
3.14.1 Descrição
Método para obter histórico de infrações utilizando uma combinação de critérios de entrada.
Retorno limitado a 1000 infrações. Para obter as infrações seguintes, o método deve ser
chamado novamente utilizando novos parâmetros.
3.14.3 RequisicaoInfracao
Nome Tipo Obr. Descrição
id Long N Ponteiro (id inicial) para o retorno das infrações. Quando
o valor informado for igual a 0 (zero), serão consideradas
as mensagens do dia atual. Será priorizado em relação
aos critérios de data.
dataPosicaoInicio Date N Data inicial (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataPosicaoFim Date N Data final (GPS) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataRecepcaoInicio Date N Data inicial (Recepção) do período no formato “aaaa-
mm-dd’T’HH:mm:ss”.
dataRecepcaoFim Date N Data final (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
3.14.5 Retorno
Igual ao método obterInfracoes.
3.15 obterTelemetria
3.15.1 Descrição
Método para obter histórico de relatórios de telemetria a partir do ponteiro informado nos
parâmetros de entrada.
Retorno limitado por padrão a 1000 relatórios. Para obter os relatórios seguintes, o método
deve ser chamado novamente utilizando o último id obtido na chamada anterior.
3.15.4 Retorno
Nome Tipo Descrição
infracao List<Infracao> Lista contendo 0 ou mais infrações.
codigoRetorno Integer 0 – Consulta retornada com sucesso
1 – Consulta não retornou dados
2-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<relatorioTelemetria>
<acionamentoFreio>0</acionamentoFreio>
<acionamentoParaBrisa>0</acionamentoParaBrisa>
<combustivelTotal>0</combustivelTotal>
<consumoMedio>0.0</consumoMedio>
<dataFim>2022-07-10T23:59:38-03:00</dataFim>
<dataInicio>2022-07-10T22:48:36-03:00</dataInicio>
<dataRecepcao>2022-07-11T00:00:03-03:00</dataRecepcao>
<distancia>19920</distancia>
<hodometro>253006030</hodometro>
<horimetro>3012931620</horimetro>
<id>130787924</id>
<idVeiculo>72510</idVeiculo>
<mediaRotacao>0</mediaRotacao>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<nome>NOME DO MOTORISTA</nome>
<login>999999</login>
<cpf>99999999999</cpf>
<idCliente>99</idCliente>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<nivelArla>0</nivelArla>
<nivelCombustivel1>0</nivelCombustivel1>
<nivelCombustivel2>0</nivelCombustivel2>
<placa>GIB-6A68</placa>
<sequencial>2571</sequencial>
<tempoAcelerandoMovimento>0</tempoAcelerandoMovimento>
<tempoAcelerandoParado>0</tempoAcelerandoParado>
<tempoDirecaoChuva>0</tempoDirecaoChuva>
<tempoDirecaoNoite>250</tempoDirecaoNoite>
<tempoFaixaAmarela>0</tempoFaixaAmarela>
<tempoFaixaAzul>0</tempoFaixaAzul>
<tempoFaixaVerde>0</tempoFaixaVerde>
<tempoFaixaVermelha>0</tempoFaixaVermelha>
<tempoFreioMotor>0</tempoFreioMotor>
<tempoInercia>0</tempoInercia>
<tempoInerciaFaixaAmarela>0</tempoInerciaFaixaAmarela>
<tempoInerciaFaixaVerde>0</tempoInerciaFaixaVerde>
<tempoInerciaFaixaVermelha>0</tempoInerciaFaixaVermelha>
<tempoMarchaLenta>16</tempoMarchaLenta>
<tempoMovimento>231</tempoMovimento>
<tempoSemAceleracaoEngrenado>0</tempoSemAceleracaoEngrenado>
<tempoTotal>0</tempoTotal>
<velocidadeMaxima>42</velocidadeMaxima>
<velocidadeMaximaChuva>0</velocidadeMaximaChuva>
<velocidadeMaximaNoite>42</velocidadeMaximaNoite>
<velocidadeMediaChuva>0</velocidadeMediaChuva>
<velocidadeMediaNoite>16</velocidadeMediaNoite>
</relatorioTelemetria>
<relatorioTelemetria>
<acionamentoFreio>137</acionamentoFreio>
<acionamentoParaBrisa>0</acionamentoParaBrisa>
<combustivelTotal>56007368</combustivelTotal>
<consumoMedio>0.0</consumoMedio>
<dataFim>2022-07-10T23:38:03-03:00</dataFim>
<dataInicio>2022-07-10T22:44:06-03:00</dataInicio>
<dataRecepcao>2022-07-11T00:00:03-03:00</dataRecepcao>
<distancia>51240</distancia>
<hodometro>141607325</hodometro>
<horimetro>9567720</horimetro>
<id>130787925</id>
<idVeiculo>140362</idVeiculo>
<mediaRotacao>1080</mediaRotacao>
<meioComunicacao>GPRS</meioComunicacao>
<motorista>
<nome>NOME DO MOTORISTA</nome>
<login>999999</login>
<cpf>99999999999</cpf>
<idCliente>99</idCliente>
<nomeCliente>NOME DO CLIENTE</nomeCliente>
</motorista>
<nivelArla>0</nivelArla>
<nivelCombustivel1>0</nivelCombustivel1>
<nivelCombustivel2>0</nivelCombustivel2>
<placa>GGP-3A43</placa>
<sequencial>775</sequencial>
<tempoAcelerandoMovimento>1541</tempoAcelerandoMovimento>
<tempoAcelerandoParado>0</tempoAcelerandoParado>
<tempoDirecaoChuva>0</tempoDirecaoChuva>
<tempoDirecaoNoite>250</tempoDirecaoNoite>
<tempoFaixaAmarela>0</tempoFaixaAmarela>
<tempoFaixaAzul>205</tempoFaixaAzul>
<tempoFaixaVerde>205</tempoFaixaVerde>
<tempoFaixaVermelha>0</tempoFaixaVermelha>
<tempoFreioMotor>18</tempoFreioMotor>
<tempoInercia>0</tempoInercia>
<tempoInerciaFaixaAmarela>3</tempoInerciaFaixaAmarela>
<tempoInerciaFaixaVerde>203</tempoInerciaFaixaVerde>
<tempoInerciaFaixaVermelha>2</tempoInerciaFaixaVermelha>
<tempoMarchaLenta>11</tempoMarchaLenta>
<tempoMovimento>238</tempoMovimento>
<tempoSemAceleracaoEngrenado>82</tempoSemAceleracaoEngrenado>
<tempoTotal>0</tempoTotal>
<velocidadeMaxima>83</velocidadeMaxima>
<velocidadeMaximaChuva>0</velocidadeMaximaChuva>
<velocidadeMaximaNoite>83</velocidadeMaximaNoite>
<velocidadeMediaChuva>0</velocidadeMediaChuva>
<velocidadeMediaNoite>57</velocidadeMediaNoite>
</relatorioTelemetria>
</return>
</w:obterInfracoesResponse>
</S:Body>
</S:Envelope>
3.16 obterTelemetriaPeriodo
3.16.1 Descrição
Método para obter histórico de relatório de telemetria no período informado nos parâmetros
de entrada.
Retorno limitado a 1000 relatórios por padrão. Para obter os relatórios seguintes, o método
deve ser chamado novamente utilizando novo período.
3.16.4 Retorno
Igual ao método obterTelemetria.
3.17 obterTelemetriaCriterio
3.17.1 Descrição
Método para obter histórico de relatórios de telemetria utilizando uma combinação de critérios
de entrada.
Retorno limitado a 1000 relatórios por padrão. Para obter os relatórios seguintes, o método
deve ser chamado novamente utilizando novos parâmetros.
3.17.3 RequisicaoTelemetria
Nome Tipo Obr. Descrição
id Long N Ponteiro (id inicial) para o retorno dos relatórios.
Quando o valor informado for igual a 0 (zero), serão
consideradas os relatórios do dia atual. Será priorizado
em relação aos critérios de data.
dataInicio Date N Data inicial do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataFim Date N Data final do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
dataRecepcaoInicio Date N Data inicial (Recepção) do período no formato “aaaa-
mm-dd’T’HH:mm:ss”.
dataRecepcaoFim Date N Data final (Recepção) do período no formato “aaaa-mm-
dd’T’HH:mm:ss”.
3.17.5 Retorno
Igual ao método obterTelemetria.
3.18 enviarMotoristas
Método para enviar informação dos motoristas para os veículos.
3.18.3 RequisicaoEmbarqueMotorista
Nome Tipo Obr. Descrição
3.18.4 ComandoEmbarqueMotorista
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo para o qual será enviada a informação dos
motoristas. Verificar Tipo 5.3.
Deverá ser informado um dos dois campos: placa ou
idVeiculo.
motorista List<Motorista> S Um ou mais motoristas a serem embarcados no
veículo. Verificar Tipo 5.2.
Deverá ser informado um dos dois campos: login ou
cpf.
codigoRetorno Integer - Somente utilizado no retorno.
0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String - Somente utilizado no retorno.
Mensagem representando o código de retorno.
3.18.5 Retorno
Nome Tipo Descrição
embarque List<ComandoEmbarqueMotorista> Lista contendo 0 ou mais posições.
codigoRetorno int 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de
retorno.
</embarque>
<embarque>
<veiculo>
<idVeiculo>222222</idVeiculo>
</veiculo>
<embarque>
<veiculo>
<idVeiculo>999999</idVeiculo>
</veiculo>
<codigoRetorno>4</codigoRetorno>
<mensagemRetorno>Veículo não encontrado</mensagemRetorno>
</embarque>
</return>
</w:enviarMotoristasResponse>
</S:Body>
</S:Envelope>
3.19 desativarMotoristas
Método para desativar o cadastro dos motoristas informados e enviar essa informação para
o SIGhRA SmartTab, evitando assim a realização de logins por motoristas desativados.
3.19.3 RequisicaoOperacaoMotorista
Nome Tipo Obr. Descrição
embarque List<ComandoMotorista> S Lista de motoristas a serem desativados
(Verificar abaixo).
3.19.4 ComandoMotorista
Nome Tipo Obr. Descrição
motorista Motorista S Motorista a ser desativado. Verificar Tipo 5.2.
Deverá ser informado um dos dois campos: login ou
cpf.
3.19.5 Retorno
Nome Tipo Descrição
operacao List<ComandoMotorista> Lista contendo os motoristas cuja desativação foi
solicitada.
codigoRetorno int 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.20 ativarMotoristas
Método para reativar o cadastro dos motoristas informados que tenham sido previamente
desativados e enviar essa informação para o SIGhRA SmartTab.
3.20.3 RequisicaoOperacaoMotorista
Nome Tipo Obr. Descrição
embarque List<ComandoMotorista> S Lista de motoristas a serem reativados
(Verificar abaixo).
3.20.4 ComandoMotorista
Nome Tipo Obr. Descrição
motorista Motorista S Motorista a ser reativado. Verificar Tipo 5.2.
3.20.5 Retorno
Nome Tipo Descrição
operacao List<ComandoMotorista> Lista contendo os motoristas cuja reativação foi
solicitada.
codigoRetorno int 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.21 enviarConfiguracoesArea
Método para enviar configuração dos grupos de área para o veículo.
3.21.3 RequisicaoConfiguracaoArea
Nome Tipo Obr. Descrição
configuracaoArea List< ComandoConfiguracaoArea> S Lista de configurações a serem
enviadas.
(Verificar Abaixo)
3.21.4 ComandoConfiguracaoArea
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo para o qual será enviado o grupo de áreas.
Verificar Tipo 5.3.
Deverá ser informado um dos dois campos: placa ou
idVeiculo.
3.21.5 Retorno
Nome Tipo Descrição
configuracaoArea List<ComandoConfiguracaoArea> Lista contendo o retorno das configurações.
codigoRetorno int 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.22 enviarConfiguracoesMacro
Método para enviar configuração dos grupos de macro para o veículo.
3.22.3 RequisicaoConfiguracaoMacro
Nome Tipo Obr. Descrição
configuracaoMacro List< ComandoConfiguracaoMacro> S Lista de configurações a serem
enviadas.
(Verificar Abaixo)
3.22.4 ComandoConfiguracaoMacro
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo para o qual será enviado o grupo de macros.
Verificar Tipo 5.3.
Deverá ser informado um dos dois campos: placa ou
idVeiculo.
3.22.5 Retorno
Nome Tipo Descrição
configuracaoMacro List<ComandoConfiguracaoMacro> Lista contendo o retorno das configurações.
codigoRetorno Integer 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de
retorno.
3.23 enviarConfiguracoesMensagemPre
Método para enviar configuração dos grupos de mensagens pré-formatadas para o veículo.
3.23.3 RequisicaoConfiguracaoMacro
Nome Tipo Obr. Descrição
configuracaoMensagemPre List<ComandoConfiguracaoMensagemPre> S Lista de configurações
a serem enviadas.
(Verificar Abaixo)
3.23.4 ComandoConfiguracaoMensagemPre
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo para o qual será enviado o grupo de
mensagens pré-formatadas. Verificar Tipo 5.3.
Deverá ser informado um dos dois campos:
placa ou idVeiculo.
3.23.5 Retorno
Nome Tipo Descrição
configuracaoMensagemPre List<ComandoConfiguracaoMensagemPre> Lista contendo o retorno das
configurações.
codigoRetorno Integer 0 – Requisição realizada com
sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o
código de retorno.
3.24 enviarConfiguracoesSensor
Método para habilitar/desabilitar sensores presentes no veículo.
3.24.3 RequisicaoConfiguracaoSensor
Nome Tipo Obr. Descrição
configuracaoSensor List<ComandoConfiguracaoSensor> S Lista de configurações a serem
enviadas.
(Verificar Abaixo)
3.24.4 ComandoConfiguracaoSensor
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo a serem configurados os sensores.
Verificar Tipo 5.3.
Deverá ser informado um dos dois campos:
placa ou idVeiculo.
sensor List<ConfiguracaoSensor> S Lista de sensores a serem
habilitados/desabilitados.
Verificar Tipo 5.7.
codigoRetorno Integer - Somente utilizado no retorno.
0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String - Somente utilizado no retorno.
Mensagem representando o código de
retorno.
3.24.5 Retorno
Nome Tipo Descrição
configuracaoSensor List<ComandoConfiguracaoSensor> Lista contendo o retorno das configurações.
codigoRetorno Integer 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de
retorno.
<sensor>
<sigla>PP</sigla>
<ativo>false</ativo>
</sensor>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</configuracaoSensor>
</return>
</w:enviarConfiguracoesSensorResponse>
</S:Body>
</S:Envelope>
3.25 enviarComandoTelefonico
Método para geração de contra-senha para execução de comando por parte do motorista.
3.25.3 RequisicaoEnvioComandoTel
Nome Tipo Obr. Descrição
comando ComandoVeiculoTel S Comando a ser executado.
(Verificar Abaixo)
3.25.4 ComandoVeiculoTel
Nome Tipo Obr. Descrição
veiculo Veiculo S Veículo a serem configurados os sensores. Verificar
Tipo 5.3.
Deverá ser informado um dos dois campos: placa ou
idVeiculo.
3.25.5 Retorno
Nome Tipo Descrição
comando ComandoVeiculoTel Comando a ser executado.
codigoRetorno Integer 0 – Requisição realizada com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.
3.26 enviarComando
3.26.1 Descrição
Envio de comando para o veículo.
3.26.5 ComandoVeiculo
Nome Tipo Obr. Descrição
idVeiculo Integer S Veículo para o qual foi enviado o comando
idAplicacao Integer S Aplicação relacionada ao comando.
Informar 0.
idComando Integer S Código do Comando enviado
id Integer S ID do comando gerado.
codigoRetorno Integer - Somente utilizado no retorno.
0 – Requisição realizada com sucesso
1-999 – Código de erro
3.27 obterVersao
3.27.1 Descrição
Método para obter a versão do WebService.
4 Tabelas
4.1 Sensores/Atuadores
Sigla Descrição Status
Sensores
P1 Botão de Pânico 1 (true se botão de pânico acionado, false caso contrário)
P2 Botão de Pânico 2 true se botão de pânico acionado, false caso contrário
PM Porta de Motorista true se porta fechada
PP Porta de Passageiro true se porta fechada
PI Porta de Baú Intermediária true se porta fechada
PT Porta de Baú Traseira true se porta fechada
PL Porta de Baú Lateral true se porta fechada
IG Ignição true se porta fechada
CA Carreta true se carreta engatada
PN Painel Violação, true se painel violado
TJ Tela de Janela Violada true se janela violada
Atuadores
SI Sirene true se sirene ligada
ST Setas true se setas ligadas
BL Bloqueio true se bloqueio acionado
BC Bloqueio de Carreta true se bloqueio da carreta acionado
TT Trava de Baú Traseiro true se trava acionada
TL Trava de Baú Lateral true se trava acionada
TI Trava de Baú Interna true se trava acionada
4.3 Eventos
Código Descrição Tipo
1023 Posição de Histórico – Satelital Posição
1025 Mensagem Livre (Veículo para Base) Mensagem
1027 Mensagem Pré-Formatada (Veículo para Base) Mensagem
1038 Confirmação de Leitura de Mensagem de Texto (Veículo para Base) Mensagem
2108 Posição Automática (Veículo Parado com ignição desligada) Posição
2112 Posição Automática via Satélite Posição
2131 Posição Automática On Line Posição
2132 Posição de Histórico Posição
11024 Mensagem de Texto (Base para Veículo) Mensagem
11025 Mensagem Pré-Formatada (Base para Veículo) Mensagem
4.4 Comandos
Código Comando Aplicação
10128 Reset Alarmes e Desbloqueio (Limpando Perfil) 0
10129 Reset Alarmes e Desbloqueio (Mantendo Perfil) 0
10130 Iniciar Seqüência de Bloqueio 0
12048 Ativar Sirene 0
12049 Desativar Sirene 0
12052 Ativar Setas 0
12053 Desativar Setas 0
12054 Bloquear Veículo 0
12055 Desbloquear Veículo 0
12058 Travar Baú Porta Traseira 0
12059 Destravar Baú Porta Traseira 0
12060 Travar Baú Porta Lateral 0
12061 Destravar Baú Porta Lateral 0
12062 Travar Baú Porta Interna 0
12063 Destravar Baú Porta Interna 0
12064 Destravar Baú Porta Traseira + Travamento Automático 0
12065 Destravar Baú Porta Lateral + Travamento Automático 0
12066 Destravar Baú Porta Interna + Travamento Automático 0
12070 Bloquear Veículo fixando Status de Alarme 0
5 Tipos Comuns
5.2 Motorista
Campo Tipo Descrição
cpf String CPF do Motorista
login String Login do Motorista
nome String Nome do Motorista
idCliente Integer Cliente do Motorista
nomeCliente String Nome do Cliente do Motorista
5.3 Veiculo
Campo Tipo Descrição
idVeiculo Integer ID do veículo.
placa String Placa do Veículo.
idFrota String Identificação de Frota do Veículo.
idCliente Integer ID do Cliente ao qual o veículo está associado.
limiteMotorista Integer Limite de motoristas que podem ser embarcados no veículo.
5.4 GrupoArea
Campo Tipo Descrição
idGrupo Integer ID do Grupo.
Obrigatório informar o idGrupo ou códigoGrupo no envio.
idTipoArea Integer Tipo de grupo de área a ser enviado:
1 – Área de Risco
2 – Centro de Distribuição
3 – Áreas de Entrega/Coleta
4 – Área de Checagem (Checkpoint)
5 – Área de Parada Autorizada
6 – Área de Rotograma.
Obrigatório.
nome String Somente utilizado no retorno.
Nome do grupo.
5.5 GrupoMacro
Campo Tipo Descrição
idGrupo Integer ID do Grupo.
Obrigatório informar o idGrupo ou códigoGrupo no envio.
nome String Somente utilizado no retorno.
Nome do grupo.
codigoGrupo Integer Código do grupo configurado pelo cliente.
Obrigatório informar codigoGrupo ou idGrupo.
5.6 GrupoMensagemPre
Campo Tipo Descrição
idGrupo Integer ID do Grupo.
Obrigatório informar o idGrupo ou códigoGrupo no envio.
nome String Somente utilizado no retorno.
Nome do grupo.
codigoGrupo Integer Código do grupo configurado pelo cliente.
Obrigatório informar codigoGrupo ou idGrupo.
5.7 ConfiguracaoSensor
Campo Tipo Descrição
sigla String Sigla do Sensor a ser habilitado/desabilitado.
Verificar tabela 4.1.
ativo boolean Informar true para habilitar o sensor, false para desabilitar o sensor