8.WS Portolog - Cancelamento de DL-e

Web service Portolog: Cancelamento de DL-e

Serviço web que efetua o processamento de cancelamento de um ou mais documentos logísticos.

Atenção:

Um DL-e pode ser cancelado somente até o seu sequenciamento, ou seja, o estado "Acesso ao Porto Confirmado". Após este estado não será mais possível o cancelamento do DL-e.

Atores que podem utilizar o Serviço:

Operador Portuário
Terminal Portuário
Ponto de Controle

Endpoint do Serviço:

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

Content-Type:

application/xml ou application/json

Parâmetros da Requisição de Cancelamento de DL-e:

Esquema XSD

Dados Gerais:

Nome	Descrição	Tipo	Tamanho	Local	Observações
versao	versão do arquivo de cancelamento de DL-e	String(Obrigatório)	4	body	Versão Atual: 1.00
cnpjEmissor	CNPJ do Sistema Externo que está solicitando o cancelamento	String(Obrigatório)	14	body

Lista de DL-es a serem Cancelados:

Nome	Descrição	Tipo	Tamanho	Local
seq	Sequencial para identificar o registro dentro do arquivo. Deve ser único para possibilitar o relacionamento no arquivo de retorno do processamento.	Numeric(Obrigatório)	-	body
numeroDle	Número do DL-e a ser Cancelado	Numeric(Obrigatório)	12	body
motivo	Motivo do Cancelamento	String(Obrigatório)	100	body

Resposta da Requisição:

Esquema XSD

Dados Gerais:

Nome	Descrição	Tipo	Observação
versao	Versão do Arquivo de Retorno de Processamento de Cancelamento de DL-e	String(Obrigatório)	Versão Atual: 1.00
dataProcessamento	Data/Hora do Registro de Processamento de Cancelamento de DL-e	Data/Hora(Obrigatório)
seq	Sequencial para identificar o registro dentro do arquivo	Numeric(Obrigatório)
mensagem	Mensagem de sucesso ou erro no processamento de cancelamento do DL-e	String(Obrigatório)
numeroDle	Número do DL-e cancelado.	Numeric(*)	(*) Campo exibido somente quando o DL-e for cancelado com sucesso.

Exemplos de Arquivos XML/JSON:

Exemplo de JSON do arquivo de cancelamento de DL-e:

        { 
            "versao":"1.00",
            "cnpjEmissor": "82951351000142",
            "DLe": 
                [
                    {
                        "seq":"0",
                        "numeroDle":"122019",
                        "motivo":"Motivo Teste"
                    }
                ]
        }

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

        {
            "dataProcessamento": "2019-12-05T12:35:52.199-03:00",
            "dleProc": 
                [
                    {
                        "mensagem": ["[IN0208] Registro processado com sucesso"],
                        "numeroDle": 20392019,
                        "seq": 0
                    }
                ],
            "versao": "1.00"
        }

Exemplo de retorno de JSON com resposta de erro:

        {
            "dataProcessamento": "2019-12-05T12:51:10.161-03:00",
            "dleProc": 
                [
                    {
                        "mensagem": ["[ER0251] O DL-e informado é inexistente."],
                        "seq": 0
                    }
                ],
            "versao": "1.00"
        }

Exemplo de XML do arquivo de cancelamento de DL-e:

    <?xml version="1.0" encoding="UTF-8"?>
        <loteCancelamentoDLe versao="1.00" xmlns="http://www.portosempapel.gov.br/dle" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/dle cancelamentoDle_v1.00.xsd ">
            <cnpjEmissor>04291660000120</cnpjEmissor>
            <DLe seq="0">
                <numeroDle>16732019</numeroDle>
                <motivo>Teste</motivo>
            </DLe>
        </loteCancelamentoDLe>

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

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <loteCancelamentoDLeProc xmlns="http://www.portosempapel.gov.br/dle" versao="1.00">
            <dataProcessamento>2019-12-05T12:59:26.221-03:00</dataProcessamento>
            <dleProc seq="0">
                <mensagem>[IN0208] Registro processado com sucesso</mensagem>
                <numeroDle>20432019</numeroDle>
            </dleProc>
        </loteCancelamentoDLeProc>

Exemplo de retorno de XML com resposta de erro:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <loteCancelamentoDLeProc xmlns="http://www.portosempapel.gov.br/dle" versao="1.00">
            <dataProcessamento>2019-12-05T13:04:52.281-03:00</dataProcessamento>
            <dleProc seq="0">
                <mensagem>[ER0205] O CNPJ do responsável pelo cancelamento não é o mesmo que o CNPJ do responsável pela criação do DL-e.</mensagem>
            </dleProc>
        </loteCancelamentoDLeProc>