Ir para o conteúdo

Web service Portolog: Consulta de Informações de DL-es Futuros

Serviço web que retorna a informação dos DL-es que estão previstos, porém ainda não sequenciados, para determinada data.

Atores que podem utilizar o Serviço:

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

Endpoint do Serviço:

POST url_base/psp-portolog-rest/api/dle/dles-futuros/v1.00

Content-Type:

application/xml ou application/json

Parâmetros da Requisição de Consulta:

Nome Descrição Tipo Tamanho Local Observações
versao Versão do arquivo da consulta de informações de DL-es Futuros String(Obrigatório) 4 body Versão Atual: 1.00
porto Bitrigrama do porto associado ao(s) DL-e(s) String(Obrigatório) 5 body
cnpjTerminal CNPJ do Terminal associado ao(s) DL-e(s) String(Opcional) 14 body
pontoPuxadaCod Código do Ponto de Controle de Puxada de Carga do(s) DL-e(s) String(Opcional) 7 body
dataAcessoPorto Data prevista de acesso ao porto do(s) DL-e(s) Data(Opcional) 10 body Formato: AAAA-MM-DD

(*) Campo obrigatório caso o campo "Data de Acesso a Puxada" não esteja preenchido.
dataAcessoPuxada Data prevista de acesso ao ponto de puxada de carga do(s) DL-e(s) Data(Opcional) 10 body Formato: AAAA-MM-DD

(*) Campo obrigatório caso o campo "Data de Acesso ao Porto" não esteja preenchido.

Observação:

Para acesso às informações dos códigos de pontos de controle de puxada de carga que atendem ao seu terminal, 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 códigos dos pontos de puxada serão iniciados sempre com "PI".

Resposta da Requisição:

Nome Descrição Tipo Observação
versao versão do arquivo de retorno da consulta de informações de DL-es Futuros String(Obrigatório) Versão Atual: 1.01
seq Sequencial do registro dentro do arquivo Numeric(Obrigatório)
numeroDle Número do DL-e Numeric(Obrigatório)
portoAcesso Bitrigrama do porto de destino do transporte String(Obrigatório)
terminalPorto CNPJ do terminal de destino do transporte String(Obrigatório)
patio Código do Ponto de Controle de Puxada de Carga do DL-e String(Opcional)
dataAcesso Data/Hora prevista de acesso ao porto do DL-e Data/Hora(Obrigatório) Formato: AAAA-MM-DDTHH:MM:SS.sssZZZ
dataAcessoPontoPuxada Data/Hora prevista de acesso ao ponto de puxada de carga do DL-e Data/Hora(Opcional) Formato: AAAA-MM-DDTHH:MM:SS.sssZZZ
placa Placa do Veículo String(Opcional)
motorista Nome do motorista String(Opcional)
origem Dados da Origem da Carga String(Obrigatório) - DL-e de EXPORTACAO, CABOTAGEM_ORIGEM OU ENTRADA_CARGA: Exibe o nome da Empresa/Pessoa de Origem da Carga.
- DL-e de IMPORTACAO, CABOTAGEM_DESTINO OU SAIDA_CARGA: Exibe o nome do terminal do DL-e.
destino Dados do destino da Carga String(Opcional) - DL-e de EXPORTACAO, CABOTAGEM_ORIGEM OU ENTRADA_CARGA: Exibe o nome do terminal do DL-e.
- DL-e de IMPORTACAO, CABOTAGEM_DESTINO OU SAIDA_CARGA: Exibe o nome da Empresa de Destino da Carga.
codigoDetalheTipoCarga Código do detalhe de tipo de carga do transporte String(Obrigatório) Domínio: Vide campo "observação" logo abaixo.
temCargaPerigosa Identificador se o transporte carrega ou não carga perigosa String(Obrigatório) Domínio:
-SIM
-NAO
cnpjResponsavelDle CNPJ do responsável pela criação do DL-e String(Obrigatório)
situacaoDle Descrição da situação do DL-e String(Obrigatório) Domínio:
-DL-e Criado
-Acesso Solicitado
-Programação Realizada

Observação:

1. Para acesso às informações dos códigos de detalhe de tipo de carga de cada porto favor consultar através do acesso à tela do Portolog, no menu "Serviços" e item de menu "Informações para Integração".

2. A exibição dos DL-es, a depender do ator que encaminhou a requisição de consulta, seguirá a seguinte regra:

              - Operador ou Terminal: Visualiza as informações dos DL-es com destino ao seu terminal
              - Ponto de Controle: Visualiza as informações dos DL-es associados ao seu ponto de puxada e com destino ao porto informado no filtro
              - Autoridade Portuária: Visualiza as informações dos 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 XML/JSON:

 

Exemplo de JSON da requisição de consulta:

        {
            "versao": "1.00",
            "porto": "BRSSZ",
            "cnpjTerminal": "82951351000142",
            "pontoPuxadaCod": "PI00009",
            "dataAcessoPorto": "2020-03-02"
        }

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

        {
        "versao": "1.01",
        "dlesFuturos":
            [
                {
                    "seq": "0",
                    "portoAcesso": "BRSSZ",
                    "terminalPorto": "82951351000142",
                    "numeroDle": 992020,
                    "patio": "PI00001",
                    "dataAcesso":"2020-03-02T08:00:00.000-03:00",
                    "dataAcessoPontoPuxada":"2020-03-01T23:00:00.000-03:00",
                    "tipoVeiculo":"TRACAO",
                    "placa":"TES1W34",
                    "motorista":"Zé Buscapé",
                    "origem": "Empresa de Origem Teste LTDA",
                    "destino": "Terminal de Cargas Teste",
                    "codigoDetalheTipoCarga": "CONT2",
                    "temCargaPerigosa": "NAO", 
                    "cnpjResponsavelDle": "82951351000142",
                    "situacaoDle": "DL-e Criado"  
                },
                {
                    "seq": "1",
                    "portoAcesso": "BRSSZ",
                    "terminalPorto": "82951351000142",
                    "numeroDle": 1102020,
                    "patio": "PI00001",
                    "dataAcesso":"2020-03-02T12:30:00.000-03:00",
                    "dataAcessoPontoPuxada":"2020-03-02T04:00:00.000-03:00",
                    "tipoVeiculo":"TRACAO",
                    "placa":"AUT8Z55",
                    "motorista":"João Bolão",
                    "origem": "Empresa Fake S/A",
                    "destino": "Terminal de Cargas Automação",
                    "codigoDetalheTipoCarga": "GRAN1",
                    "temCargaPerigosa": "SIM", 
                    "cnpjResponsavelDle": "82951351000142",
                    "situacaoDle": "Acesso Solicitado"  
                }
            ]
        }

Exemplo de JSON com resposta de erro:

        {
            "dataProcessamento" : "2020-02-25T18:10:52.417-03:00",
            "mensagem" : [ "[ER0198] O emissor informado no arquivo não possui acesso ao terminal portuário informado." ]
        }

Exemplo de XML da requisição de consulta:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dlesFuturosFiltro versao="1.00">
    <porto>BRSSZ</porto>
    <cnpjTerminal>82951351000142</cnpjTerminal>
    <dataAcessoPorto>2020-03-05</dataTermino>
</dlesFuturosFiltro>

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<procdlesFuturos versao="1.01">
    <dlesFuturos seq="0">
        <portoAcesso>BRSSZ</portoAcesso>
        <terminalPorto>82951351000142</terminalPorto>
        <patio>PI00009</patio>
        <numeroDle>1562020</numeroDle>
        <tipoVeiculo>TRACAO</tipoVeiculo>
        <placa>ASX3Y45</placa>
        <dataAcesso>2020-03-05T18:30:00.000-03:00</dataAcesso>
        <dataAcessoPontoPuxada>2020-03-05T12:30:00.000-03:00</dataAcessoPontoPuxada>
        <motorista>Jon Jones</motorista>
        <origem>Empresa MultiNacional LTDA</origem>
        <destino>Terminal MMA</destino>
        <codigoDetalheTipoCarga>CONT1</codigoDetalheTipoCarga>
        <temCargaPerigosa>SIM</temCargaPerigosa>
        <cnpjResponsavelDle>82951351000142</cnpjResponsavelDle>
        <situacaoDle>DL-e Criado</situacaoDle>
    </dlesFuturos>
    <dlesFuturos seq="1">
        <portoAcesso>BRSSZ</portoAcesso>
        <terminalPorto>82951351000142</terminalPorto>
        <patio>PI00007</patio>
        <numeroDle>1622020</numeroDle>
        <tipoVeiculo>TRACAO</tipoVeiculo>
        <placa>WWH1G99</placa>
        <dataAcesso>2020-03-05T21:15:00.000-03:00</dataAcesso>
        <dataAcessoPontoPuxada>2020-03-05T15:15:00.000-03:00</dataAcessoPontoPuxada>
        <motorista>José Wilker</motorista>
        <origem>Empresa Teste Ltda</origem>
        <destino>Terminal de Santos</destino>
        <codigoDetalheTipoCarga>CONT2</codigoDetalheTipoCarga>
        <temCargaPerigosa>NAO</temCargaPerigosa>
        <cnpjResponsavelDle>82951351000142</cnpjResponsavelDle>
        <situacaoDle>Acesso Solicitado</situacaoDle>
    </dlesFuturos>
</procdlesFuturos>

Exemplo de XML com resposta de erro:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <procdlesFuturos xmlns="http://www.portosempapel.gov.br/dle" versao="1.01">
        <dataProcessamento>2020-03-03T14:52:43.478-03:00</dataProcessamento>
        <mensagem>[ER0198] O emissor informado no arquivo não possui acesso ao terminal portuário informado.</mensagem>
    </procdlesFuturos>