Web service Portolog: Informação de Rastreamentos
Serviço web que importa e processa as informações de rastreamento de um determinado transporte efetivadas nos diversos pontos de controle cadastrados no Portolog.
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/novo/v1.04
Content-Type:
application/xml ou application/json
Parâmetros da Requisição de Importação de Rastreamento:
Dados Gerais:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| versao | versão do arquivo de rastreamento | String(Obrigatório) | 4 | body | Versão Atual: 1.04 |
| placa | Placa do Transporte | String(Obrigatório) | 7 | body | |
| numeroDle | Número do DL-e Associado a Viagem | Numeric(Opcional) | 12 | body | |
| idPontoControle | Código do Ponto de Controle | String(Obrigatório) | 7 | body | Domínio: Vide campo "observação" logo abaixo. |
| portao | Código do Portão do Ponto de Controle | String(*) | 5 | body | (*) Campo obrigatório somente para rastreamentos em pontos de controle do tipo "Terminal" ou "Porto". |
| tipo | Tipo do Evento de Registro de Rastreamento | String(Obrigatório) | 8 | body | Domínio: Entrada, Saída ou Passagem. |
| dataHoraPassagem | Data/Hora do evento de passagem do transporte no ponto de controle | Data/Hora(Obrigatório) | 8 | body | Formato: AAAA-MM-DDTHH:MM:SS |
| modal | Modal do transporte que movimenta a carga | String(Obrigatório) | 20 | body | Domínio: RODOVIARIO |
| idTag | Código de Identificação Eletrônica do Transporte(Etiqueta RFID) | String(Opcional) | 24 | body | |
| pesoBruto | Peso Bruto do Transporte em toneladas | Numeric(Opcional) | (7,4) | body | |
| tipoCarga | Tipo de Carga Transportado | String(Opcional) | 15 | body | |
| operacao | Natureza de Operação do DL-e | String(Opcional) | 30 | body | Domínio: ABASTECIMENTO_COMBUSTIVEL, ABASTECIMENTO_PROVISAO, CABOTAGEM_DESTINO, CABOTAGEM_ORIGEM, COLETA_RESIDUOS, EXPORTACAO, IMPORTACAO, OUTROS, TRANSPORTE_ENTRE_TERMINAIS, TRANSPORTE_CONTEINERES_VAZIOS, ENTRADA_CARGA e SAIDA_CARGA |
| terminal | CNPJ do terminal de destino do transporte | String(*) | 14 | body | (*) Campo obrigatório quando o rastreamento for em um ponto Intermediário com estrutura de pátio regulador e cujo transporte não possua DL-e associado. |
| porto | Código bitrigrama do porto de destino do transporte | String(*) | 5 | body | (*) Campo obrigatório quando o rastreamento for em um ponto Intermediário com estrutura de pátio regulador e cujo transporte não possua DL-e associado. |
Dados do Contêiner(Opcionais):
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| idTag | Código de Identificação Eletrônica do Produto(Etiqueta RFID) | String(Opcional) | 24 | body | |
| numero | Número do Contêiner | String(Opcional) | 11 | body |
Observação:
Para acesso às informações dos códigos de pontos de controle, favor consultar através do acesso à tela do Portolog, no menu "Serviços" e item de menu "Informações para Integração" selecionando o tipo "Ponto de Controle". Os pontos de controle serão identificados na listagem seguindo os seguintes critérios:
1. Os códigos dos pontos de puxada ou pontos intermediários de passagem ao longo das rodovias terão seus mnemônicos iniciados sempre com "PI".
2. Os códigos dos pontos de controle associado aos terminais serão iniciados com "TP".
3. Os códigos dos pontos de controle do Porto serão iniciados por "PO".
4. Os códigos dos pontos de controle de uma Empresa de Origem da Carga serão iniciados com "EO".
5. Os códigos dos pontos de controle de uma Pessoa de Origem da carga serão iniciados com "PE".
6. Os códigos dos pontos de controle do tipo "Pré-Gate" serão iniciados com "PG".
Resposta da Requisição:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| situacao | Situação do Processamento do Rastreamento | String(Obrigatório) | Domínio: - Confirmado - Não Confirmado |
| motivo | Descrição do motivo do rastreamento não ter sido confirmado | String(Opcional) | (*) Campo exibido somente se a situação do processamento do rastreamento for "Não Confirmado". |
| numeroDle | Número do DL-e | Numeric(Opcional) | (*) Campo exibido somente se a situação do processamento do rastreamento for "Confirmado" e o rastreamento tiver sido associado a um DL-e. |
| dataHoraRegistro | Data/Hora do Registro de Processamento do Rastreamento | Data/Hora(Obrigatório) | Formato: AAAA-MM-DDTHH:MM:SS:msmsms ZZZZ |
| tipo | Tipo do Registro do Rastreamento | String(Obrigatório) | Domínio: Entrada, Saída ou Passagem. |
| placa | Placa do Transporte | String(Obrigatório) | |
| versao | Versão do Retorno de Processamento do Rastreamento | String(Obrigatório) | Versão Atual: 1.01 |
| terminal | CNPJ do terminal de destino do transporte | String(Opcional) | Exibido quando o rastreamento for em um ponto Intermediário com estrutura de pátio regulador e cujo transporte não possua DL-e associado. |
| porto | Código bitrigrama do porto de destino do transporte | String(Opcional) | Exibido quando o rastreamento for em um ponto Intermediário com estrutura de pátio regulador e cujo transporte não possua DL-e associado. |
Exemplos de Arquivos XML/JSON:
Exemplo de JSON do arquivo de importação de rastreamento:
{
"versao": "1.04",
"placa": "TES4567",
"idPontoControle": "TP01234",
"portao": "E1010",
"tipoEvento": "ENTRADA",
"dataHoraEvento": "2019-09-13T16:32:00",
"modal": "RODOVIARIO"
}
Exemplo de retorno de JSON com a resposta da requisição:
{
"situacao": "Confirmado",
"numeroDle": 502019,
"placa": "C98O2X7",
"dataHoraRegistro": "2019-09-13T16:50:00",
"tipo": "ENTRADA",
"versao": "1.01"
}
Exemplo de retorno de JSON com resposta de erro:
{
"situacao": "Não Confirmado",
"motivo": "[ER0174] Não foi localizado o identificador do ponto de controle informado",
"placa": "C98O2X7",
"dataHoraRegistro": "2019-09-13T16:55:00.211-03:00",
"tipo": "ENTRADA",
"versao": "1.01"
}
Exemplo de XML do arquivo de importação de rastreamento:
<rastreamento versao="1.04">
<tipo>ENTRADA</tipo>
<idPontoControle>PI00009</idPontoControle>
<dataHoraPassagem>2019-09-23T12:30:36</dataHoraPassagem>
<modal>RODOVIARIO</modal>
<placa>RW916NY</placa>
<operacao>EXPORTACAO</operacao>
</rastreamento>
Exemplo de retorno de XML com a resposta da requisição:
<retornoRastreamento xmlns="http://www.portosempapel.gov.br" versao="1.01">
<numeroDle>13772019</numeroDle>
<placa>RW916NY</placa>
<dataHoraRegistro>2019-09-23T12:31:17.411-03:00</dataHoraRegistro>
<tipo>ENTRADA</tipo>
<situacao>Confirmado</situacao>
</retornoRastreamento>
Exemplo de retorno de XML com resposta de erro:
<retornoRastreamento xmlns="http://www.portosempapel.gov.br" versao="1.01">
<placa>RW916NY</placa>
<dataHoraRegistro>2019-09-23T12:32:39.236-03:00</dataHoraRegistro>
<tipo>ENTRADA</tipo>
<situacao>Não Confirmado</situacao>
<motivo>[ER0254] Porto de destino não informado.</motivo>
</retornoRastreamento>