12.WS Portolog - Sequenciamento de Transportes

Web service Portolog: Sequenciamento de Transportes

Serviço web que processa os pedidos de sequenciamento dos DL-es dos terminais e retorna o horário agendado que o transporte deve acessar o porto/terminal, bem como os horários mínimo e máximo de acesso ao ponto de puxada, caso ele exista.

Observações:

1. Para ser possível sequenciar os DL-es de natureza EXPORTACAO, CABOTAGEM_ORIGEM e ENTRADA_CARGA será necessário antes importar e associar o documento de origem ao DL-e, conforme web service de informação de documento de origem e web service de ligação de DL-e com documento de origem .

2. Para ser possível sequenciar os DL-es de natureza IMPORTACAO, CABOTAGEM_DESTINO e SAIDA_CARGA será necessário existir no DL-e a informação da placa do transporte e de pelo menos um item de carga, conforme definido nas sessões "Lista de Itens de Carga" e "Dados do Transporte", disponíveis no web service de criação de DL-e e no web service de alteração de DL-e .

Atores que podem utilizar o Serviço:

Operador Portuário
Terminal Portuário

Endpoint do Serviço:

POST url_base/psp-portolog-rest/api/sequenciamento/novo/v1.02

Content-Type:

application/xml ou application/json

Parâmetros da Requisição de Sequenciamento de Transportes:

Esquema XSD

Dados Gerais:

Nome	Descrição	Tipo	Tamanho	Local	Observações
versao	versão do arquivo de sequenciamento	String(Obrigatório)	4	body	Versão Atual: 1.02
cnpjTerminal	CNPJ do terminal de destino do transporte	String(Obrigatório)	14	body
porto	Código bitrigrama do porto de destino do transporte	String(Obrigatório)	5	body
numeroDle	Número do DL-e do Transporte	Numeric(Obrigatório)	9	body
dataEntrada	Data/Hora de Entrada do Transporte no Porto/Terminal	Data/Hora(Obrigatório)	16	body	Formato: DD/MM/AAAA HH:mm
dataSaida	Data/Hora de Saída do Transporte no Porto/Terminal	Data/Hora(Obrigatório)	16	body	Formato: DD/MM/AAAA HH:mm

Resposta da Requisição:

Esquema XSD

Dados Gerais:

Nome	Descrição	Tipo	Observação
versao	Versão do Arquivo de Retorno de Processamento de Rastreamento	String(Obrigatório)	Versão Atual: 1.00
dataProcessamento	Data/Hora do Registro de Processamento do Sequenciamento	Data/Hora(Obrigatório)
mensagem	Mensagem de confirmação ou erro no processamento do sequenciamento do registro	String(Obrigatório)

Dados do Sequenciamento(Exibidos somente se o sequenciamento for efetivado com sucesso):

Nome	Descrição	Tipo	Observação
numeroDle	Número do DL-e do Transporte	Numeric(Obrigatório)
dataSequenciada	Data/Hora Confirmada de Entrada do Transporte no Porto/Terminal	Data/Hora(Obrigatório)	Formato: AAAA/MM/DD T HH:mm:ss:msmsms ZZZZ
pontoPuxada	Ponto de Controle de Puxada de Carga do Transporte	String(Opcional)
dataInicialEntradaPuxada	Data/Hora Mínima de Entrada do Transporte no Ponto de Puxada	Data/Hora(Opcional)	Formato: AAAA/MM/DD T HH:mm:ss:msmsms ZZZZ
dataFinalEntradaPuxada	Data/Hora Limite para Entrada do Transporte no Ponto de Puxada	Data/Hora(Opcional)	Formato: AAAA/MM/DD T HH:mm:ss:msmsms ZZZZ

Exemplos de Arquivos XML/JSON:

Exemplo de JSON do arquivo de sequenciamento de transportes:

       {
            "versao": "1.02",
            "cnpjTerminal":"04291660000120",
            "porto":"BRVIX",
            "programacao": 
                {
                    "numeroDle":"82019",
                    "dataEntrada":"25/10/2019 08:00",
                    "dataSaida":"25/10/2019 08:30"
                }
        }

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

        {
            "dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
            "programacao" : 
                {
                    "mensagem" : [ "[IN0208] Registro processado com sucesso" ],
                    "numeroDle": 1232019,
                    "dataSequenciada": "2019-11-06T12:10:12.000-03:00",
                    "pontoPuxada": "PI00009",
                    "dataInicialEntradaPuxada": "2019-11-06T10:30:00.000-03:00",
                    "dataFinalEntradaPuxada": "2019-11-06T10:30:00.000-03:00",

                },
            "versao" : "1.00"
        }

Exemplo de retorno de JSON com resposta de erro:

        {
            "dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
            "programacao" : 
                {
                    "mensagem" : [ "[ER0089] Não existe quantidade atendida para este detalhe do tipo de carga na programação preliminar" ]
                },
            "versao" : "1.00"
        }

Exemplo de XML do arquivo de sequenciamento de transportes:

    <?xml version="1.0" encoding="utf-8"?>
        <sequenciamento versao="1.02" xmlns="http://www.portosempapel.gov.br">
            <cnpjTerminal>46591057000103</cnpjTerminal>
            <porto>BRITJ</porto>
            <programacao>
                <numeroDle>12019</numeroDle>
                <dataEntrada>06/11/2019 11:40</dataEntrada>
                <dataSaida>06/11/2019 15:50</dataSaida>
            </programacao>
        </sequenciamento>

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resultadoSequenciamento xmlns="http://www.portosempapel.gov.br" versao="1.00">
    <dataProcessamento>2019-11-04T14:38:17.140-03:00</dataProcessamento>
    <programacao>
        <mensagem>[IN0208] Registro processado com sucesso</mensagem>
        <numeroDle>12019</numeroDle>
        <dataSequenciada>2019-11-06T12:10:12.000-03:00</dataSequenciada>
        <pontoPuxada>PI00009</pontoPuxada>
        <dataInicialEntradaPuxada>2019-11-06T10:30:00.000-03:00</dataInicialEntradaPuxada>
        <dataFinalEntradaPuxada>2019-11-06T11:00:00.000-03:00</dataFinalEntradaPuxada>
    </programacao>
</resultadoSequenciamento>

Exemplo de retorno de XML com resposta de erro:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resultadoSequenciamento xmlns="http://www.portosempapel.gov.br" versao="1.00">
    <dataProcessamento>2019-11-04T12:49:33.298-03:00</dataProcessamento>
    <programacao>
        <mensagem>[ER0122] A situação atual do DL-e não permite programação</mensagem>
    </programacao>
</resultadoSequenciamento>