Você está na página 1de 77

Data 03/02/2023

Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 1 de 77
Código

Integração SIGhRA

Web Service SOAP

Versão 1.7.3

Data 03/02/2023

Documento Documentacao_Web_Service_SIGhRA_v01.07.03.pdf

Autores Carlos Henrique da Cunha Pereira


cpereira@sighra.com.br

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 2 de 77
Código

Índice
1 Controle de Revisões ............................................................................................................. 4

1.1 Histórico de Versões ......................................................................................................... 4

2 Introdução ............................................................................................................................... 5

3 Métodos disponíveis............................................................................................................... 6

3.1 obterUltimaPosicao ........................................................................................................... 7

3.2 obterPosicoes ................................................................................................................. 10

3.3 obterPosicoesPeriodo ..................................................................................................... 13

3.4 obterPosicoesCriterio ...................................................................................................... 14

3.5 obterMacros .................................................................................................................... 16

3.6 obterMacrosPeriodo ........................................................................................................ 19

3.7 obterMacrosCriterio ......................................................................................................... 20

3.8 obterMensagens.............................................................................................................. 22

3.9 obterMensagensPeriodo ................................................................................................. 24

3.10 obterMensagensCriterio .................................................................................................. 26

3.11 enviarMensagem ............................................................................................................. 28

3.12 obterInfracoes ................................................................................................................. 29

3.13 obterInfracoesPeriodo ..................................................................................................... 36

3.14 obterInfracoesCriterio ...................................................................................................... 37

3.15 obterTelemetria ............................................................................................................... 39

3.16 obterTelemetriaPeriodo ................................................................................................... 44

3.17 obterTelemetriaCriterio .................................................................................................... 45

3.18 enviarMotoristas .............................................................................................................. 47

3.19 desativarMotoristas ......................................................................................................... 50

3.20 ativarMotoristas ............................................................................................................... 52

3.21 enviarConfiguracoesArea ................................................................................................ 55

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 3 de 77
Código

3.22 enviarConfiguracoesMacro .............................................................................................. 58

3.23 enviarConfiguracoesMensagemPre................................................................................. 61

3.24 enviarConfiguracoesSensor ............................................................................................ 64

3.25 enviarComandoTelefonico ............................................................................................... 67

3.26 enviarComando ............................................................................................................... 70

3.27 obterVersao..................................................................................................................... 72

4 Tabelas .................................................................................................................................. 73

4.1 Sensores/Atuadores ........................................................................................................ 73

4.2 Tipos de Macro................................................................................................................ 74

4.3 Eventos ........................................................................................................................... 75

4.4 Comandos ....................................................................................................................... 75

5 Tipos Comuns ....................................................................................................................... 76

5.1 Status dos Sensores/Atuadores (SensorAtuador) ........................................................... 76

5.2 Motorista ......................................................................................................................... 76

5.3 Veiculo ............................................................................................................................ 76

5.4 GrupoArea....................................................................................................................... 76

5.5 GrupoMacro .................................................................................................................... 77

5.6 GrupoMensagemPre ....................................................................................................... 77

5.7 ConfiguracaoSensor ........................................................................................................ 77

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 4 de 77
Código

1 Controle de Revisões

1.1 Histórico de Versões


Data Versão Descrição
03/02/2023 1.7.3 Adição do hodômetro nos métodos de macro e mensagem.
22/12/2022 1.7.2 Ajustes ponteiro de infrações.
09/12/2022 1.7.1 Ajustes pesquisa por data de recepção (infração / mensagem / macro /
posição).
11/07/2022 1.7.0 Adição de métodos de obtenção de relatórios de telemetria.
24/03/2022 1.6.4 Adição de campos de origem e ID de evento no retorno do WS de
Mensagens.
11/03/2022 1.6.3 Desativação/Reativação de Motoristas.
03/03/2022 1.6.2 Criação de parâmetros ENVIA_SENSOR_AUSENTE e
ENVIA_ATUADOR_AUSENTE para controlar o retorno de informações
de sensores e atualizadores que não possuam status ou não estejam
configurados no veículo.
08/08/2021 1.6.0 Novos métodos:
- Envio de Grupo de Macro
- Envio de Grupo de Área
- Envio de Grupo de Mensagens Pré-Formatadas
- Solicitação de Comando Telefônico
- Envio de Comando
- Controle de Sensores
23/07/2021 1.5.2 Adição de infrações de guinada brusca e aceleração/desaceleração
longitudinal.
07/07/2021 1.5.1 Caso não seja adicionada informação de grupo no arquivo de
configuração, os grupos passam a ser obtidos por usuário.

Adição de método para verificação da versão.


26/10/2020 1.5.0 Adição de campo ponto de referência na posição, infração, macro e
mensagem.

Adição de informação de número de satélites e dop na infração, macro


e mensagem.

Adição de métodos obterPosicoesCriterio, obterMacrosCriterio,


obterInfracoesCriterio, obterMensagensCriterio para buscas com
parâmetros adicionais de entrada.

Adição de infrações de jornada.

Adição de código de evento no retorno de posições.

Adição de método para embarque de motoristas (enviarMotoristas).


15/09/2020 1.4.0 Adição de informações de motorista na posição e na macro.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 5 de 77
Código

Adição de métodos de obtenção de infrações.


16/03/2020 1.3.1 Adição de campos de informação de número de satélite, dop, bateria,
horímetro e posição online/memória na posição.
04/03/2020 1.3.0 Adição de método de última posição.
26/02/2020 1.2.0 Adição de informação de hodômetro.
16/08/2019 1.1.0 Adição de Informação de Sensores e Atuadores
02/07/2019 1.0.0 Versão Inicial do Documento

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 6 de 77
Código

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 7 de 77
Código

3.1 obterUltimaPosicao
Método para obter a última posição dos veículos ativos cadastrados na base.

3.1.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema

3.1.2 Exemplo de Requisição


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterUltimaPosicao>
<usuario>usuario</usuario>
<senha>senha</senha>
</ws:obterUltimaPosicao>
</soapenv:Body>
</soapenv:Envelope>

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.1.4 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterPosicoesResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<posicao>
<alarme>false</alarme>
<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>
<idVeiculo>99999</idVeiculo>
<ignicao>true</ignicao>
<latitude>-22.7582</latitude>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 8 de 77
Código

<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>

3.1.5 Detalhe Retorno (Posicao)


Campo Tipo Descrição
sequencial Integer Número sequencial da última 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
dataPosicao Date Data/Hora da geração da posição GPS
latitude Double Latitude do veículo
longitude Double Longitude do veículo

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 9 de 77
Código

curso Integer Curso (direção) do Veículo (em graus)


ignicao 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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 10 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idPosicao Long S 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.

3.2.3 Exemplo de Requisição


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterPosicoes>
<usuario>usuario</usuario>
<senha>senha</senha>
<idPosicao>0</idPosicao>
</ws:obterPosicoes>
</soapenv:Body>
</soapenv:Envelope>

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.

3.2.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterPosicoesResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<posicao>
<alarme>false</alarme>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 11 de 77
Código

<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>

3.2.6 Detalhe Retorno (Posicao)


Campo Tipo Descrição

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 12 de 77
Código

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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 13 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
dataIni String S Data inicial do período no formato “aaaa-mm-dd‘T’HH:mm:ss”
dataFim String S Data final do período no formato “aaaa-mm-dd‘T’HH:mm:ss”

3.3.3 Exemplo de Requisição


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterPosicoesPeriodo>
<usuario>usuario</usuario>
<senha>senha</senha>
<dataIni>2019-06-01T09:30:27</dataIni>
<dataFim>2019-06-01T14:30:27</dataFim>
</ws:obterPosicoesPeriodo>
</soapenv:Body>
</soapenv:Envelope>

3.3.4 Retorno
Igual ao método obterPosicoes.

3.3.5 Exemplo de Retorno


Igual ao método obterPosicoes.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 14 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoPosicao S Parâmetros de Entrada (Verificar Abaixo)

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.

3.4.4 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterPosicoesCriterio>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<id>0</id>
<status>false</status>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 15 de 77
Código

</requisicao>
</ws:obterPosicoesCriterio>
</soapenv:Body>
</soapenv:Envelope>

3.4.5 Retorno
Igual ao método obterPosicoes.

3.4.6 Exemplo de Retorno


Igual ao método obterPosicoes.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 16 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idMacro Long S 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.

3.5.3 Exemplo de Requisição


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterMacros>
<usuario>usuario</usuario>
<senha>senha</senha>
<idMacro>0</idMacro>
</ws:obterMacros>
</soapenv:Body>
</soapenv:Envelope>

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.

3.5.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterMacrosResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<macro>
<cidade>PILAR DO SUL</cidade>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 17 de 77
Código

<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.5.6 Detalhe Retorno (Macro)


Campo Tipo Descrição
id Long Id da Macro
sequencial Integer Número sequencial da macro 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 da recepção da macro no servidor
latitude Double Latitude do veículo

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 18 de 77
Código

longitude Double Longitude do veículo


numeroSat Integer Número de satélites utilizados para a obtenção da posição GPS
dop Integer DOP da última posição GPS
curso Integer Curso (direção) do Veículo (em graus)
ignição Boolean Indica se a ignição estava ligada no momento do envio da macro
velocidade Integer Velocidade do veículo no momento do envio da macro
meioComunicacao String Meio de comunicação utilizado no envio pelo equipamento
(GPRS ou Satelital)
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
numeroMacro String Número da macro informada pelo motorista
dataMacro Date Data/Hora em que o motorista enviou a macro
macro String Nome da macro
formulario String Formulário preenchido pelo motorista no envio da macro
tipoMacro String Tipo da macro (Verificar Tabela 4.2)
hodometro Long Hodômetro do veículo
motorista Motorista Motorista logado no veículo. Verificar Tipo 5.2.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 19 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
dataIni String S Data inicial do período no formato “aaaa-mm-dd’T’HH:mm:ss”
dataFim String S Data final do período no formato “aaaa-mm-dd’T’HH:mm:ss”

3.6.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterMacrosPeriodo>
<usuario>usuario</usuario>
<senha>senha</senha>
<dataIni>2019-06-01T09:30:27</dataIni>
<dataFim>2019-06-01T14:30:27</dataFim>
</ws:obterMacrosPeriodo>
</soapenv:Body>
</soapenv:Envelope>

3.6.4 Retorno
Igual ao método obterMacros.

3.6.5 Exemplo de Retorno


Igual ao método obterMacros.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 20 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoMacro S Parâmetros de Entrada (Verificar Abaixo)

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.4 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterPosicoesMacro>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<id>0</id>
</requisicao>
</ws:obterPosicoesMacro>
</soapenv:Body>
</soapenv:Envelope>

3.7.5 Retorno
Igual ao método obterMacros.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 21 de 77
Código

3.7.6 Exemplo de Retorno


Igual ao método obterMacros.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 22 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idMensagem Long S 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.

3.8.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterMensagens>
<usuario>usuario</usuario>
<senha>senha</senha>
<idMensagem>0</idMensagem>
</ws:obterMensagens>
</soapenv:Body>
</soapenv:Envelope>

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.

3.8.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterMensagensResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<mensagem>
<cidade>CURITIBA</cidade>
<curso>128</curso>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 23 de 77
Código

<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.8.6 Detalhe Retorno (Mensagem)


Campo Descrição
id Long Id da mensagem
sequencial Integer Número sequencial da mensagem 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 mensagem no servidor
dataMensagem Date Data/Hora em que o motorista enviou a mensagem
latitude Double Latitude do veículo
longitude Double Longitude do veículo
numeroSat Integer Número de satélites utilizados para a obtenção da posição GPS
dop Integer DOP da última posição GPS
curso Integer Curso (direção) do Veículo (em graus)
ignição Boolean Indica se a ignição estava ligada no momento do envio da mensagem
velocidade Integer Velocidade do veículo no momento do envio da mensagem

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 24 de 77
Código

meioComunicacao String Meio de comunicação utilizado no envio pelo equipamento (GPRS


ou Satelital)
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
hodometro Long Hodômetro do Veículo
mensagem String Mensagem enviada pelo motorista ou operador
origem String Origem da Mensagem.
V = Veículo
O = Operação (Base)
idEvento Integer ID do evento correspondente ao tipo de mensagem.
Verificar tabela 4.3, eventos do tipo Mensagem.

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
dataIni String S Data inicial do período no formato “aaaa-mm-dd’T’HH:mm:ss”
dataFim String S Data final do período no formato “aaaa-mm-dd’T’HH:mm:ss”

3.9.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterMensagensPeriodo>
<usuario>usuario</usuario>
<senha>senha</senha>
<dataIni>2019-06-01 09:30:27</dataIni>
<dataFim>2019-06-01 14:30:27</dataFim>
</ws:obterMensagensPeriodo>
</soapenv:Body>
</soapenv:Envelope>

3.9.4 Retorno
Igual ao método obterMensagens.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 25 de 77
Código

3.9.5 Exemplo de Retorno


Igual ao método obterMensagens.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 26 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoMensagem S Parâmetros de Entrada (Verificar Abaixo)

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.4 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterMensagensCriterio>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<id>0</id>
</requisicao>
</ws:obterMensagensCriterio>
</soapenv:Body>
</soapenv:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 27 de 77
Código

3.10.5 Retorno
Igual ao método obterMensagens.

3.10.6 Exemplo de Retorno


Igual ao método obterMensagens.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 28 de 77
Código

3.11 enviarMensagem

3.11.1 Descrição
Envio de mensagem para o veículo.

3.11.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idVeiculo Integer S ID do veículo.
mensagem String S Texto da mensagem a ser enviadas. (Limite de 450
caracteres).

3.11.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarMensagem>
<usuario>usuario</usuario>
<senha>senha</senha>
<idVeiculo>1000</idVeiculo>
<mensagem>Não esqueça entregar a documentação no posto de fiscalização</mensagem>
</ws:enviarMensagem>
</soapenv:Body>
</soapenv:Envelope>

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.11.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarMensagemResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Envio solicitado com sucesso</mensagemRetorno>
</return>
</w:enviarMensagemResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 29 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idInfracao Long S Ponteiro (id inicial) para o retorno das infrações.
Quando o valor informado for igual a 0 (zero), serão
consideradas as primeiras infrações do dia atual.

3.12.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterInfracoes>
<usuario>usuario</usuario>
<senha>senha</senha>
<idInfracao>0</idInfracao>
</ws:obterInfracoes>
</soapenv:Body>
</soapenv:Envelope>

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.

3.12.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterInfracoesResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">

<infracao>
<cidade>SÃO BERNARDO DO CAMPO</cidade>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 30 de 77
Código

<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>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 31 de 77
Código

<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>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 32 de 77
Código

<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>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 33 de 77
Código

<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>

3.12.6 Detalhe Retorno (Infracao)


Campo Tipo Descrição
id Long Id da Macro
sequencial Integer Número sequencial da infraçã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 da recepção da infração no servidor
latitude Double Latitude do veículo
longitude Double Longitude do veículo
numeroSat Integer Número de satélites utilizados para a obtenção da posição
GPS
dop Integer DOP da última posição GPS
dataInfracao Date Data/Hora GPS que ocorreu a infração.
cidade String Cidade na qual o veículo se encontrava no momento da
infração
estado String Estado no qual o veículo se encontrava no momento da
infração
logradouro String Logradouro mais próximo
pontoReferencia String Ponto de referência mais próximo
meioComunicacao String Meio de comunicação utilizado no envio pelo equipamento
(GPRS ou Satelital)
tipoInfracao String Tipo da infração:
INFRACAO_VELOCIDADE_MAXIMA
INFRACAO_VELOCIDADE_MAXIMA_CHUVA

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 34 de 77
Código

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).

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 35 de 77
Código

Disponível para tipo(s):


INFRACAO_FRENAGEM_BRUSCA
desaceleracao Integer Desaceleração aferida durante a infração (km/h/s).
Disponível para tipo(s):
INFRACAO_FRENAGEM_BRUSCA
forcaLimite Double Força de aceleração ou desaceleração limite configurada no
equipamento (G).
Disponível para tipo(s):
INFRACAO_GUINADA_BRUSCA_DIREITA
INFRACAO_GUINADA_BRUSCA_ESQUERDA
INFRACAO_ACELERACAO_LONGITUDINAL
INFRACAO_DESACELERACAO_LONGITUDINAL
forca Double Força de aceleração ou desaceleração aferida durante a
infração (G).
Disponível para tipo(s):
INFRACAO_GUINADA_BRUSCA_DIREITA
INFRACAO_GUINADA_BRUSCA_ESQUERDA
INFRACAO_ACELERACAO_LONGITUDINAL
INFRACAO_DESACELERACAO_LONGITUDINAL
velocidadeInicial Integer Velocidade aferida no início da infração (km/h).
Disponível para tipo(s):
INFRACAO_FRENAGEM_BRUSCA
INFRACAO_GUINADA_BRUSCA_DIREITA
INFRACAO_GUINADA_BRUSCA_ESQUERDA
INFRACAO_ACELERACAO_LONGITUDINAL
INFRACAO_DESACELERACAO_LONGITUDINAL
rotacaoLimite Integer Rotação máxima configurada no equipamento (rpm).
Disponível para tipo(s):
INFRACAO_ROTACAO
rotacaoMaxima Integer Rotação máxima aferida durante a infração (rpm).
Disponível para tipo(s):
INFRACAO_ROTACAO

velocidadeMedia Integer Velocidade média aferida durante a infração (km/h).


Disponível para tipo(s):
INFRACAO_VELOCIDADE_MAXIMA
INFRACAO_VELOCIDADE_MAXIMA_CHUVA
INFRACAO_BANGUELA
INFRACAO_ROTACAO
areaInfracao Integer Nome da Área de Rotograma onde ocorreu a infração.
Disponível para
tipo(s):INFRACAO_VELOCIDADE_AREA_ROTOGRAMA.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 36 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
dataIni String S Data inicial do período no formato “aaaa-mm-dd’T’HH:mm:ss”
dataFim String S Data final do período no formato “aaaa-mm-dd’T’HH:mm:ss”

3.13.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterInfracoesPeriodo>
<usuario>usuario</usuario>
<senha>senha</senha>
<dataIni>2020-09-14 09:00:00</dataIni>
<dataFim>2020-09-14 10:00:00</dataFim>
</ws:obterInfracoesPeriodo>
</soapenv:Body>
</soapenv:Envelope>

3.13.4 Retorno
Igual ao método obterInfracoes.

3.13.5 Exemplo de Retorno


Igual ao método obterInfracoes.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 37 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoInfracao S Parâmetros de Entrada (Verificar Abaixo)

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.4 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterInfracoesCriterio>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<id>0</id>
</requisicao>
</ws:obterInfracoesCriterio>
</soapenv:Body>
</soapenv:Envelope>

3.14.5 Retorno
Igual ao método obterInfracoes.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 38 de 77
Código

3.14.6 Exemplo de Retorno


Igual ao método obterInfracoes.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 39 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
Id Long S Ponteiro (id inicial) para o retorno dos relatórios de
telemetria. Quando o valor informado for igual a 0
(zero), serão considerados os primeiros relatórios do
dia atual.

3.15.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterTelemetria>
<usuario>usuario</usuario>
<senha>senha</senha>
<id>0</id>
</ws:obterTelemetria>
</soapenv:Body>
</soapenv:Envelope>

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.

3.15.5 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterInfracoesResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">

<codigoRetorno>0</codigoRetorno>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 40 de 77
Código

<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>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 41 de 77
Código

<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>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 42 de 77
Código

<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.15.6 Detalhe Retorno (Infracao)


Campo Tipo Descrição
id Integer Id do Relatório
sequencial Integer Número sequencial do relatório 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 da recepção do relatório de telemetria no
servidor.
dataInicio Date Data de início do relatório.
dataFim Date Data de final do relatório.
meioComunicacao String Meio de Comunicação (GPRS/Satelital).
motorista Motorista Motorista logado no veículo. Verificar Tipo 5.2.
tempoTotal Integer Tempo de duração do relatório (em segundos).
distancia Integer Distância percorrida (m).
hodometro Integer Hodômetro atual do veículo (KM).
horimetro Integer Horímetro atual do veículo.
tempoMarchaLenta Integer Tempo em marcha lenta (s).
consumoMedio Double Consumo médio do veículo.
tempoFaixaVerde Integer Tempo em faixa verde.
velocidadeMaxima Integer Velocidade máxima atingida.
velocidadeMediaChuva Integer Velocidade média em chuva.
velocidadeMaximaChuva Integer Velocidade máxima em chuva.
velocidadeMediaNoite Integer Velocidade média em período noturno.
velocidadeMaximaNoite Integer Velocidade máxima em período noturno.
tempoDirecaoChuva Integer Tempo de direção em chuva.
tempoDirecaoNoite Integer Tempo de direção em período noturno.
tempoMovimento Integer Tempo em movimento.
acionamentoParaBrisa Integer Número de acionamentos do para brisa.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 43 de 77
Código

acionamentoFreio Integer Número de acionamentos do freio.


combustivelTotal Integer Total de combustível.
nivelCombustivel1 Integer Nível de combustível 1.
nivelCombustivel2 Integer Nível de combustível 2.
tempoAcelerandoParado Integer Tempo acelerando parado.
tempoSemAceleracaoEngrenado Integer Tempo sem aceleração com veículo engrenado.
tempoFreioMotor Integer Tempo de freio motor acionado.
tempoFaixaAzul Integer Tempo em faixa azul.
tempoFaixaAmarela Integer Tempo em faixa amarela.
tempoFaixaVermelha Integer Tempo em faixa vermelha.
tempoAcelerandoMovimento Integer Tempo acelerando com veículo em movimento.
mediaRotacao Integer Média de rotação.
tempoInercia Integer Tempo em inércia.
tempoInerciaFaixaVerde Integer Tempo em inércia faixa verde.
tempoInerciaFaixaAmarela Integer Tempo em inércia faixa amarela.
tempoInerciaFaixaVermelha Integer Tempo em inércia faixa vermelha.
nivelArla Integer Nível ARLA.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 44 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
dataIni String S Data inicial do período no formato “aaaa-mm-dd’T’HH:mm:ss”
dataFim String S Data final do período no formato “aaaa-mm-dd’T’HH:mm:ss”

3.16.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterTelemetriaPeriodo>
<usuario>usuario</usuario>
<senha>senha</senha>
<dataIni>2020-09-14 09:00:00</dataIni>
<dataFim>2020-09-14 10:00:00</dataFim>
</ws:obterTelemetriaPeriodo>
</soapenv:Body>
</soapenv:Envelope>

3.16.4 Retorno
Igual ao método obterTelemetria.

3.16.5 Exemplo de Retorno


Igual ao método obterTelemetria.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 45 de 77
Código

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.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoTelemetria S Parâmetros de Entrada (Verificar Abaixo)

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.4 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterTelemetriaCriterio>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<id>0</id>
</requisicao>
</ws:obterTelemetriaCriterio>
</soapenv:Body>
</soapenv:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 46 de 77
Código

3.17.5 Retorno
Igual ao método obterTelemetria.

3.17.6 Exemplo de Retorno


Igual ao método obterTelemetria.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 47 de 77
Código

3.18 enviarMotoristas
Método para enviar informação dos motoristas para os veículos.

3.18.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoEmbarqueMotorista S Lista de embarque de motoristas.
(Verificar Abaixo)

3.18.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarMotoristas>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<embarque>
<veiculo>
<idVeiculo>99999</idVeiculo>
</veiculo>
<motorista>
<login>999999</login>
</motorista>
<motorista>
<cpf>11111111111</cpf>
</motorista>
</embarque>
<embarque>
<veiculo>
<placa>AAA1234</placa>
</veiculo>
<motorista>
<login>888888</login>
</motorista>
</embarque>
</requisicao>
</ws:enviarMotoristas>
</soapenv:Body>
</soapenv:Envelope>

3.18.3 RequisicaoEmbarqueMotorista
Nome Tipo Obr. Descrição

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 48 de 77
Código

embarque List<ComandoEmbarqueMotorista> S Lista de embarques a serem realizados.


(Verificar Abaixo)

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.

3.18.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarMotoristasResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<embarque>
<veiculo>
<idVeiculo>111111</idVeiculo>
<placa>AAA-1234</placa>
<idCliente>12</idCliente>
<limiteMotorista>200</limiteMotorista>
</veiculo>
<motorista>
<login>111111</login>
<cpf>11111111111</cpf>
</motorista>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 49 de 77
Código

</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.18.7 Detalhe Retorno (ComandoEmbarqueMotorista)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhum motorista terá sido embarcado, em nenhum veículo.
- Adição de código de retorno para cada veículo. Caso seja retornado um código de erro
(codigoRetorno > 0), nenhum motorista foi embarcado para aquele veículo.
- Constarão no retorno apenas os motoristas cujo embarque foi realizado de forma bem-
sucedida, sendo ignorados motoristas não cadastrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 50 de 77
Código

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.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoOperacaoMotorista S Lista de motoristas a serem desativados
(Verificar Abaixo).

3.19.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:desativarMotoristas>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<operacao>
<motorista>
<login>222222</login>
</motorista>
</operacao>
<operacao>
<motorista>
<login>111111</login>
</motorista>
</operacao>
</requisicao>
</ws:desativarMotoristas>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 51 de 77
Código

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.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.19.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:desativarMotoristasResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<operacao>
<motorista>
<login>222222</login>
<cpf>22222222222</cpf>
<idCliente>12</idCliente>
</motorista>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</operacao>
</return>
</w:desativarMotoristasResponse>
</S:Body>
</S:Envelope>

3.19.7 Detalhe Retorno (ComandoMotorista)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhum motorista teve sua desativação solicitada.
- Adição de código de retorno para cada motorista. Caso seja retornado um código de erro
(codigoRetorno > 0), há algum erro na solicitação de desativação do motorista.
- Serão ignorados os motoristas não cadastrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 52 de 77
Código

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.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoOperacaoMotorista S Lista de motoristas a serem reativados
(Verificar Abaixo).

3.20.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:ativarMotoristas>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<operacao>
<motorista>
<login>222222</login>
</motorista>
</operacao>
<operacao>
<motorista>
<login>111111</login>
</motorista>
</operacao>
</requisicao>
</ws:ativarMotoristas>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 53 de 77
Código

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.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.20.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:ativarMotoristasResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<operacao>
<motorista>
<login>222222</login>
<cpf>22222222222</cpf>
<idCliente>12</idCliente>
</motorista>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</operacao>
</return>
</w:ativarMotoristasResponse>
</S:Body>
</S:Envelope>

3.20.7 Detalhe Retorno (ComandoMotorista)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhum motorista teve sua reativação solicitada.
- Adição de código de retorno para cada motorista. Caso seja retornado um código de erro
(codigoRetorno > 0), há algum erro na solicitação de reativação do motorista.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 54 de 77
Código

- Serão ignorados os motoristas não cadastrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 55 de 77
Código

3.21 enviarConfiguracoesArea
Método para enviar configuração dos grupos de área para o veículo.

3.21.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoConfiguracaoArea S Lista de configurações de áreas a serem
enviadas para os veículos

3.21.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarConfiguracoesArea>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<configuracaoArea>
<veiculo>
<idVeiculo>999999</idVeiculo>
</veiculo>
<grupoArea>
<idGrupo>1</idGrupo>
<idTipoArea>1</idTipoArea>
</grupoArea>
</configuracaoArea>
</requisicao>
</ws:enviarConfiguracoesArea>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 56 de 77
Código

grupoArea GrupoArea S Grupo de área a ser embarcado no veículo. Verificar


Tipo 5.4.
Deverá ser informado um dos dois campos: idGrupo
ou codigoGrupo.
Para apagar as áreas existentes no veículo, informar
idGrupo com o valor 0 (zero).
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.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.21.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarConfiguracoesAreaResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<configuracaoArea>
<veiculo>
<idVeiculo>999999</idVeiculo>
<placa>ABC-1234</placa>
</veiculo>
<grupoArea>
<idGrupo>1</idGrupo>
<idTipoArea>1</idTipoArea>
<nome>Áreas de Risco</nome>
</grupoArea>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</configuracaoArea>
</return>
</w:enviarConfiguracoesAreaResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 57 de 77
Código

3.21.7 Detalhe Retorno (ComandoConfiguracaoArea)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhuma configuração será enviada, em nenhum veículo.
- Adição de código de retorno para cada veículo. Caso seja retornado um código de erro
(codigoRetorno > 0), nenhuma configuração foi enviada para aquele veículo.
- Constarão no retorno apenas as configurações enviadas de forma bem-sucedida, sendo
ignorados grupos de áreas não encontrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 58 de 77
Código

3.22 enviarConfiguracoesMacro
Método para enviar configuração dos grupos de macro para o veículo.

3.22.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoConfiguracaoMacro S Lista de configurações de macros a
serem enviadas para os veículos

3.22.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarConfiguracoesMacro>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<configuracaoMacro>
<veiculo>
<idVeiculo>999999</idVeiculo>
</veiculo>
<grupoMacro>
<idGrupo>1</idGrupo>
</grupoMacro>
</configuracaoMacro>
</requisicao>
</ws:enviarConfiguracoesMacro>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 59 de 77
Código

grupoMacro GrupoMacro S Grupo de macro a ser embarcado no veículo. Verificar


Tipo 5.5.
Deverá ser informado um dos dois campos: idGrupo
ou codigoGrupo.
Para apagar os grupos de macros existentes no
veículo, informar idGrupo com o valor 0 (zero).
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.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.22.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarConfiguracoesMacroResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<configuracaoMacro>
<veiculo>
<idVeiculo>999999</idVeiculo>
<placa>ABC-1234</placa>
</veiculo>
<grupoMacro>
<idGrupo>1</idGrupo>
<nome>JORNADA</nome>
</grupoMacro>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</configuracaoMacro>
</return>
</w:enviarConfiguracoesMacroResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 60 de 77
Código

3.22.7 Detalhe Retorno (ComandoConfiguracaoArea)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhuma configuração será enviada, para nenhum veículo.
- Adição de código de retorno para cada veículo. Caso seja retornado um código de erro
(codigoRetorno > 0), nenhuma configuração foi enviada para aquele veículo.
- Constarão no retorno apenas as configurações enviadas de forma bem-sucedida, sendo
ignorados grupos de macros não encontrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 61 de 77
Código

3.23 enviarConfiguracoesMensagemPre
Método para enviar configuração dos grupos de mensagens pré-formatadas para o veículo.

3.23.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoConfiguracaoMensagemPre S Lista de configurações de
mensagens pré a serem enviadas
para os veículos

3.23.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarConfiguracoesMensagemPre>
<usuario>usuario</usuario>
<senha>senha</senha>
<requisicao>
<configuracaoMensagemPre>
<veiculo>
<idVeiculo>999999</idVeiculo>
</veiculo>
<grupoMensagem>
<idGrupo>1</idGrupo>
</grupoMensagem>
</configuracaoMensagemPre>
</requisicao>
</ws:enviarConfiguracoesMensagemPre>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 62 de 77
Código

grupoMensagem GrupoMensagemPre S Grupo de mensagem pré-formatada a ser


embarcado no veículo. Verificar Tipo 5.6.
Deverá ser informado um dos dois campos:
idGrupo ou codigoGrupo.
Para apagar os grupos de mensagens existentes
no veículo, informar idGrupo com o valor 0
(zero).
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.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.23.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarConfiguracoesMensagemPreResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<configuracaoMensagemPre>
<veiculo>
<idVeiculo>999999</idVeiculo>
<placa>ABC-1234</placa>
</veiculo>
<grupoMensagem>
<idGrupo>1</idGrupo>
<nome>Mensagens Padrão</nome>
</grupoMensagem>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</configuracaoMensagemPre>
</return>
</w:enviarConfiguracoesMensagemPreResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 63 de 77
Código

3.23.7 Detalhe Retorno (ComandoConfiguracaoMensagemPre)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhuma configuração será enviada, para nenhum veículo.
- Adição de código de retorno para cada veículo. Caso seja retornado um código de erro
(codigoRetorno > 0), nenhuma configuração foi enviada para aquele veículo.
- Constarão no retorno apenas as configurações enviadas de forma bem-sucedida, sendo
ignorados grupos de mensagens não encontrados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 64 de 77
Código

3.24 enviarConfiguracoesSensor
Método para habilitar/desabilitar sensores presentes no veículo.

3.24.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoConfiguracaoSensor S Lista de sensores a serem
habilitados/desabilitados nos veículos.

3.24.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarConfiguracoesSensor>
<usuario>admin</usuario>
<senha>admin</senha>
<requisicao>
<configuracaoSensor>
<veiculo>
<idVeiculo>999999</idVeiculo>
</veiculo>
<sensor>
<sigla>P1</sigla>
<ativo>true</ativo>
</sensor>
<sensor>
<sigla>PM</sigla>
<ativo>false</ativo>
</sensor>
<sensor>
<sigla>PP</sigla>
<ativo>false</ativo>
</sensor>
</configuracaoSensor>
</requisicao>
</ws:enviarConfiguracoesSensor>
</soapenv:Body>
</soapenv:Envelope>

3.24.3 RequisicaoConfiguracaoSensor
Nome Tipo Obr. Descrição
configuracaoSensor List<ComandoConfiguracaoSensor> S Lista de configurações a serem
enviadas.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 65 de 77
Código

(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.

3.24.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarConfiguracoesSensorResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<configuracaoSensor>
<veiculo>
<idVeiculo>999999</idVeiculo>
<placa>ABC-1234</placa>
</veiculo>
<sensor>
<sigla>P1</sigla>
<ativo>true</ativo>
</sensor>
<sensor>
<sigla>PM</sigla>
<ativo>false</ativo>
</sensor>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 66 de 77
Código

<sensor>
<sigla>PP</sigla>
<ativo>false</ativo>
</sensor>
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
</configuracaoSensor>
</return>
</w:enviarConfiguracoesSensorResponse>
</S:Body>
</S:Envelope>

3.24.7 Detalhe Retorno (ComandoConfiguracaoMensagemPre)


O retorno da requisição é semelhante ao formato de entrada, com as seguintes diferenças de
preenchimento:
- Adição de código de retorno para o arquivo como um todo. Caso seja retornado um erro no
arquivo (codigoRetorno > 0), nenhuma configuração será enviada, para nenhum veículo.
- Adição de código de retorno para cada veículo. Caso seja retornado um código de erro
(codigoRetorno > 0), nenhuma configuração foi enviada para aquele veículo.
- Sensores não encontrados no veículo serão ignorados.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 67 de 77
Código

3.25 enviarComandoTelefonico
Método para geração de contra-senha para execução de comando por parte do motorista.

3.25.1 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
requisicao RequisicaoEnvioComandoTel S Requisição de comando a ser executado.

3.25.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarComandoTelefonico>
<usuario>admin</usuario>
<senha>admin</senha>
<requisicao>
<comando>
<veiculo>
<idVeiculo>58080</idVeiculo>
</veiculo>
<idAplicacao>0</idAplicacao>
<idComando>10130</idComando>
<senha1>4EFE</senha1>
<senha2>BDFF</senha2>
<senha3>7EDB</senha3>
<senha4>FF3C</senha4>
</comando>
</requisicao>
</ws:enviarComandoTelefonico>
</soapenv:Body>
</soapenv:Envelope>

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 68 de 77
Código

idAplicacao Integer S Aplicação.


Informar 0.
idComando Integer S Verificar tabela 4.4.
senha1 String S Bloco 1 da senha informada pelo motorista.
senha2 String S Bloco 2 da senha informada pelo motorista.
senha3 String S Bloco 3 da senha informada pelo motorista.
senha4 String S Bloco 4 da senha informada pelo motorista.
contrasenha String - Somente utilizado no retorno.
Senha gerada a ser informada para o motorista.
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.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.25.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarComandoTelefonicoResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<comando>
<veiculo>
<idVeiculo>999999</idVeiculo>
<placa>ABC-1234</placa>
</veiculo>
<idAplicacao>0</idAplicacao>
<idComando>10130</idComando>
<senha1>4EFE</senha1>
<senha2>BDFF</senha2>
<senha3>7EDB</senha3>
<senha4>FF3C</senha4>
<contrasenha>585826425</contrasenha>
</comando>
</return>
</w:enviarComandoTelefonicoResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 69 de 77
Código

3.25.7 Detalhe Retorno (ComandoVeiculoTel)


O retorno da requisição é semelhante ao formato de entrada, com a adição do campo
contrasenha. Esta senha deverá ser passada para o motorista para que o comando seja executado
no veículo.
Caso seja retornado um código de erro (codigoRetorno > 0), não será gerada contrasenha.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 70 de 77
Código

3.26 enviarComando

3.26.1 Descrição
Envio de comando para o veículo.

3.26.2 Parâmetros de Entrada


Nome Tipo Obrigatório Descrição
usuario String S Usuário de acesso ao sistema
senha String S Senha de acesso ao sistema
idVeiculo Integer S ID do veículo.
idAplicacao Integer S Informar 0.
idComando Integer S Verificar tabela 4.4.

3.26.3 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:enviarComando>
<usuario>usuario</usuario>
<senha>senha</senha>
<idVeiculo>999999</idVeiculo>
<idAplicacao>0</idAplicacao>
<idComando>10130</idComando>
</ws:enviarComando>
</soapenv:Body>
</soapenv:Envelope>

3.26.4 Retorno (RespostaComando)


Nome Tipo Descrição
comando ComandoVeiculo Retorno do comando enviado (verificar abaixo).
codigoRetorno Integer 0 – Envio solicitado com sucesso
1-999 – Código de erro
mensagemRetorno String Mensagem representando o código de retorno.

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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 71 de 77
Código

mensagemRetorno String - Somente utilizado no retorno.


Mensagem representando o código de retorno.

3.26.6 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:enviarComandoResponse xmlns:w="http://ws.sighra.com/">
<return xmlns:ns0="http://ws.sighra.com/">
<codigoRetorno>0</codigoRetorno>
<mensagemRetorno>Sucesso</mensagemRetorno>
<comando>
<id>372297</id>
<idAplicacao>0</idAplicacao>
<idComando>10130</idComando>
<idVeiculo>58080</idVeiculo>
</comando>
</return>
</w:enviarComandoResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 72 de 77
Código

3.27 obterVersao

3.27.1 Descrição
Método para obter a versão do WebService.

3.27.2 Exemplo de Requisição


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.sighra.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:obterVersao/>
</soapenv:Body>
</soapenv:Envelope>

3.27.3 Exemplo de Retorno


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<w:obterVersaoResponse xmlns:w="http://ws.sighra.com/">
<return>01.06.00</return>
</w:obterVersaoResponse>
</S:Body>
</S:Envelope>

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 73 de 77
Código

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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 74 de 77
Código

4.2 Tipos de Macro


Tipo
Início de Viagem
Parada
Operação
Solicitação
Reinício de Viagem
Fim de Viagem
Outros
Script de Segurança
Início de Jornada
Fim de Jornada
Refeição
Entrada em Reserva
Saída de Reserva
Início de Carregamento
Fim de Carregamento
Início de Descarregamento
Fim de Descarregamento
Início de Espera
Fim de Espera
Descanso

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 75 de 77
Código

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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 76 de 77
Código

5 Tipos Comuns

5.1 Status dos Sensores/Atuadores (SensorAtuador)


Campo Tipo Descrição
tipo String ‘Sensor’ ou ‘Atuador’
sigla String Verificar Tabela 4.1
descrição String Descrição do Sensor/Atuador
status Boolean Verificar Tabela 4.1
descricaoStatus String Descrição do Status

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.

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA
Data 03/02/2023
Versão 1.7.3
Cópia
Integração Revisão 03/02/2023
Páginas 77 de 77
Código

codigoGrupo Integer Código do grupo configurado pelo cliente.


Obrigatório informar codigoGrupo ou idGrupo.

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

Projeto e propriedade intelectual – SIGHRA SISTEMAS INOVADORES


DOCUMENTO CONTROLADO – REPRODUÇÃO PROIBIDA

Você também pode gostar