15.WS Portolog - Consulta de Rastreamentos

Web service Portolog: Consulta de Rastreamentos

Serviço web que possibilita tanto consultar os rastreamentos associados a um determinado DL-e quanto consultar os rastreamentos encaminhados de forma automática aos sistemas externos de todos os DL-es que estejam marcados para serem rastreados de forma automática (vide Web service rastreamento automático de transporte).

Atores que podem utilizar o Serviço:

Operador Portuário
Terminal Portuário
Autoridade Portuária
ANTT
Ponto de Controle

Endpoint do Serviço:

POST url_base/psp-portolog-rest/api/rastreamento/consulta/v1.00

Content-Type:

application/json

Parâmetros da Requisição de Consulta de Rastreamentos:

Nome	Descrição	Tipo	Tamanho	Local	Observações
numDLe	Número do DL-e	Numeric(*)	12	body	(*) Obrigatório caso o campo "uri" não seja preenchido.
dataInicialEnvio	Data de início da pesquisa para verificação do envio automático de um rastreamento ao sistema externo	Data(Opcional)	8	body	Formato: DD/MM/AAAA
dataFinalEnvio	Data de fim da pesquisa para verificação do envio automático de um rastreamento ao sistema externo	Data(Opcional)	8	body	Formato: DD/MM/AAAA
statusEnvio	Status do envio automático dos rastreamentos ao sistema externo	Numeric(Opcional)	1	body	Domínio: 1-PENDENTE_ENVIO/ 2-SUCESSO/ 3-ERRO. PENDENTE_ENVIO: Devolverá todos os rastreamentos que possuem pendência de envio ao sistema externo. SUCESSO: Devolverá todos os rastreamentos que foram enviados com sucesso ao sistema externo. ERRO: Devolverá todos os rastreamentos que por alguma falha NÃO foram enviados ao sistema externo. *()**Caso esse campo não seja informado a consulta devolverá todos os rastreamentos, pendentes, com sucesso e com erro de envio.
uri	URI com o caminho do serviço do sistema externo que possua DL-es rastreados automaticamente	String(*)	100	body	(*) Obrigatório caso o campo "numDLe" não seja preenchido.

Observações:

1. Caso o sistema externo queira consultar as informações de rastreamento associados a um determinado DL-e deverá preencher somente o campo "numDLe" na requisição. Essa requisição sempre retornará TODOS os rastreamentos já associados a um determinado DL-e.

2. Caso o sistema externo possua DL-es rastreados automaticamente e queira consultar as informações dos rastreamentos que estão pendentes de envio, com sucesso, ou com erro no envio para determinada URI, o campo "uri" deve ser preenchido e o campo "numDLe" não deve ser preenchido. Os demais campos são filtros da pesquisa e são opcionais. Essa forma de pesquisa servirá principalmente para os sistemas externos recuperarem as informações de rastreamento não recebidas em caso de alguma falha em sua rede local, bem como de indisponibilidade do serviço de envio automático de rastreamentos ou do serviço que recebe essas informações do sistema externo.

Resposta da Requisição:

Informações Gerais do Rastreamento:

Nome	Descrição	Tipo	Observação
dataHoraRastreamento	Data e Hora do Evento de Rastreamento	Data/Hora
codPontoControle	Código do Ponto de Controle	String
nmPontoControle	Descrição do Ponto de Controle	String
tipoEvento	Tipo do Evento do Rastreamento	String	Domínio: - Entrada - Saída - Passagem
tipoPontoControle	Descrição do Tipo de Ponto de Controle	String	Domínio: - Ponto Intermediário - Empresa de Origem - Pessoa de Origem - Terminal - Porto - Puxada de Carga - Ponto Intermediário - Pré-gate
latitude	Latitude do Ponto de Controle	String	Formato: "NNºNN'NN''C", sendo que N = Número e C = N ou S.
longitude	Longitude do Ponto de Controle	String	Formato: "NNNºNN'NN''C", sendo que N = Número e C = L ou O.
numDLe	Número do DL-e	Numeric
placa	Placa do Veículo	String

Informações do Endereço do Ponto de Controle:

Nome	Descrição	Tipo
cep		Numeric
logradouro		String
endNum	Número do Endereço	Numeric
complemento		String
bairro		String
município		String
uf	Sigla da Unidade da Federação	String

Observações:

1. As mensagens de erro serão devolvidas em uma lista de String e não em um objeto JSON.

2. Caso não existam registros que atendam aos parâmetros informados na requisição de consulta o sistema retornará na resposta da requisição uma lista vazia.

3. A exibição das informações de rastreamento, a depender do ator que encaminhou a requisição de consulta, seguirá a seguinte regra:

              - Operador ou Terminal: Serão encaminhadas somente informações de rastreamento de DL-es com destino ao seu próprio terminal
              - Ponto de Controle: Serão encaminhadas somente informações de rastreamento de DL-es associados ao seu próprio ponto de controle
              - Autoridade Portuária: Serão encaminhadas somente informações de rastreamento de DL-es com destino ao seu porto
              - ANTT: Visualiza as informações dos DL-es com destino a qualquer um dos portos informados no filtro.

Exemplos de Arquivos JSON:

Exemplo da requisição de consulta de rastreamentos de um determinado DL-e:

        {
            "numDle":4652019
        }

Exemplo da requisição de consulta de rastreamentos com ERRO de envio de todos os DL-es que estejam sendo monitorados automaticamente para determinada URI:

        {
            "dataInicialEnvio": "15/06/2019",
            "dataFinalEnvio": "16/06/2019",
            "statusEnvio": 3, 
            "uri":"https://MeuHost/path"
        }

Exemplo de JSON com a resposta da requisição:

  [
    {
           "dataHoraRastreamento": "15/06/2019 10:31",
           "codPontoControle": "PC1234",
           "nmPontoControle": "Ecopátio",
           "tipoEvento": "Entrada",
           "tipoPontoControle": "Puxada de Carga",
           "latitude": "23°51′23″ S",
           "longitude": "46°16′13″ W",
           "cep": 88000100,
           "logradouro": "Rua Teste",
           "endNum": 500,
           "complemento": "proximo ao mercado jequiti",
           "bairro": "teste",
           "municipio": "Florianópolis",
           "uf": "SC",
           "placa": "TES1234",         
           "numDle": 4652019
    },
  {
           "dataHoraRastreamento": "16/06/2019 00:20",
           "codPontoControle": "PC1234",
           "nmPontoControle": "Ecopátio",
           "tipoEvento": "Saída",
           "tipoPontoControle": "Puxada de Carga",
           "latitude": "23°51′23″ S",
           "longitude": "46°16′13″ W",
           "cep": 88000100,
           "logradouro": "Rua Teste",
           "endNum": 500,
           "complemento": "proximo ao mercado jequiti",
           "bairro": "teste",
           "municipio": "Florianópolis",
           "uf": "SC",
           "placa": "TES1234",         
           "numDle": 4652019
    }
  ]

Exemplo de JSON com resposta de erro:

        [
            "[ER0120] O DL-e informado não existe ou o usuário não tem permissão para realizar alterações no DL-e informado."
        ]