Ir para o conteúdo

Web service Portolog: Consulta de Agendamento de Transporte

Serviço web que retorna informações de DL-es com sequenciamento confirmado associados a uma determinada placa e/ou período de tempo.

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/sequenciamento/consulta/v1.00

Content-Type:

application/json

Parâmetros da Requisição de Consulta:

Nome Descrição Tipo Tamanho Local Observação
placa Placa do Veículo String(Opcional) 7 body
cpfMotorista CPF do Motorista Long(Opcional) 11 body
bitrigramaPorto Código bitrigrama do porto para o qual o transporte tenha agendamento String(Opcional) 5 body
dataInicial Data de Início da Pesquisa Data(Obrigatório) 10 body Formato: DD/MM/AAAA
dataFinal Data de Fim da Pesquisa Data(Obrigatório) 10 body Formato: DD/MM/AAAA
ressequenciadoContingencia Filtro que indica se a consulta deve retornar somente os DL-es ressequenciados de forma automática pelo sistema após o encerramento de uma contingência. Mais informações sobre contingência acessar o Web service de envio de informações de contingência boolean(Opcional) 5 body Domínio:
-true
-false

Atenção:

1. Caso o campo "placa" não seja informado o período máximo permitido de pesquisa será de 5 dias.

2. O campo de filtro "bitrigramaPorto" só será útil para sistemas externos que possuem acesso a mais de um porto. Caso o sistema externo só possua acesso a um único porto será desnecessário informá-lo, pois a consulta buscará os agendamentos associados ao porto do sistema externo que estiver encaminhando a requisição. Caso na requisição de consulta seja informado um porto ao qual o sistema externo não tenha acesso será encaminhado na resposta da requisição uma lista vazia.

Resposta da Requisição:

Nome Descrição Tipo Observação
numDle Número do DL-e Numeric(Obrigatório)
numDuv Número do DUV associado ao DL-e caso ele exista Numeric(Opcional)
placa Placa do Veículo String(Obrigatório)
nmPorto Porto de Destino do Transporte String(Obrigatório)
nmTerminal Terminal de Destino do Transporte String(Obrigatório)
pontoPuxada Descrição do Ponto de Puxada de Carga do DL-e String(Opcional)
dataMaxChegadaPuxada Data/Hora Máxima de Entrada do Transporte no Ponto de Puxada do DL-e Data/Hora(Opcional) Formato: DD/MM/AAAA HH:MM
dataMinChegadaPuxada Data/Hora Mínima de Entrada do Transporte no Ponto de Puxada do DL-e Data/Hora(Opcional) Formato: DD/MM/AAAA HH:MM
dataEntradaTerminal Data/Hora Agendada para Entrada do Transporte no Terminal Data/Hora(Obrigatório) Formato: DD/MM/AAAA HH:MM
dataMaxEntradaTerminal Data/Hora Máxima para Entrada do Transporte no Terminal Data/Hora(Obrigatório) Formato: DD/MM/AAAA HH:MM
dataMinEntradaTerminal Data/Hora Mínima para Entrada do Transporte no Terminal Data/Hora(Obrigatório) Formato: DD/MM/AAAA HH:MM
naturezaOp Natureza de Operação do DL-e String(Obrigatório) Domínio: Exportação, Importação, Entrada de Carga, Saída de Carga, Cabotagem de Origem e Cabotagem de Destino
tipoCarga Tipo de Carga transportado String(Obrigatório)
detalheTipoCarga Detalhe do Tipo de Carga transportado String(Obrigatório)
nmMotorista Nome do Motorista String(Opcional)
cpfMotorista CPF do Motorista Long(Opcional)

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 rastreamentos para o DL-e informado na requisição de rastreamento o sistema retornará uma lista vazia.

3. A exibição dos agendamentos, a depender do ator que encaminhou a requisição de consulta, seguirá a seguinte regra:

              - Operador ou Terminal: Visualiza somente os agendamentos dos DL-es associados ao seu terminal
              - Ponto de Controle: Visualiza somente os agendamentos dos DL-es associados ao seu ponto de puxada
              - Autoridade Portuária: Visualiza somente os agendamentos dos DL-es associados ao seu porto
              - ANTT: Visualiza os agendamentos de todos os portos

 

Exemplos de Arquivos JSON:

 

Exemplo de JSON da requisição de consulta:

        {
            "placa": "TES1234",
            "bitrigramaPorto": "BRSSZ",
            "cpfMotorista": 22222222222,
            "dataInicial": "15/06/2019",
            "dataFinal": "16/06/2019"
        }

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

    [
        {
            "numDle": 4642019,
            "placa": "TES1234",
            "nmPorto": "Santos",
            "nmTerminal": "CUTRALE",
            "pontoPuxada": "Ecopátio",
            "dataMaxChegadaPuxada": "15/06/2019 15:00",
            "dataMinChegadaPuxada": "15/06/2019 10:00",
            "dataEntradaTerminal": "15/06/2019 19:00",
            "dataMaxEntradaTerminal": "16/06/2019 00:00",
            "dataMinEntradaTerminal": "15/06/2019 14:00",
            "tipoCarga": "Granel",
            "detalheTipoCarga": "Soja",
            "naturezaOp": "Exportação",
            "cpfMotorista": 22222222222,
            "nmMotorista": "João da Silva"
        },
        {
            "numDle": 4652019,
            "numDuv": 1002019,
            "placa": "TES1234",
            "nmPorto": "Santos",
            "nmTerminal": "ADM",
            "pontoPuxada": "Rodopark",
            "dataMaxChegadaPuxada": "16/06/2019 10:00",
            "dataMinChegadaPuxada": "16/06/2019 05:00",
            "dataEntradaTerminal": "16/06/2019 14:00",
            "dataMaxEntradaTerminal": "16/06/2019 19:00",
            "dataMinEntradaTerminal": "16/06/2019 09:00",
            "tipoCarga": "Granel",
            "detalheTipoCarga": "Milho",
            "naturezaOp": "Importação",
            "cpfMotorista": 22222222222,
            "nmMotorista": "João da Silva"
        }
    ]

Exemplo de JSON com resposta de erro:

        [
            "[ER0001] O campo dataInicial é obrigatório.", "[ER0001] O campo dataFinal é obrigatório."
        ]