Ir para o conteúdo

Web service Portolog: Exclusão de Programação Preliminar

Serviço web que efetua o processamento do pedido de exclusão de um ou mais pedidos de programação preliminar dentro do Portolog.

Atenção:

Caso já tenha ocorrido o cálculo das quantidades atendidas da programação preliminar não será mais possível excluí-la.

Atores que podem utilizar o Serviço:

  • Operador Portuário
  • Terminal Portuário

Endpoint do Serviço:

POST url_base/psp-portolog-rest/api/programacao-preliminar/exclui/v1.00

Content-Type:

application/xml ou application/json

Parâmetros da Requisição de Exclusão de Programação Preliminar:

Dados Gerais:

Nome Descrição Tipo Tamanho Local Observações
versao versão do arquivo de exclusão da programação preliminar String(Obrigatório) 4 body Versão Atual: 1.00
cnpjTerminal CNPJ do Terminal associado a programação preliminar String(Obrigatório) 14 body
porto Bitrigrama do Porto associado a programação preliminar String(Obrigatório) 5 body

Lista de Programações Preliminares:

Nome Descrição Tipo Tamanho Local Observações
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
data Data da programação preliminar Data(Obrigatório) 10 body Formato: AAAA-MM-DD
janelaTempo Código da Janela de Tempo da Programação Preliminar Numeric(Obrigatório) - body Domínio: Vide campo "observação" logo abaixo.

Observação:

Para acesso às informações dos códigos de janela de tempo e 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".

 

Resposta da Requisição:

Dados Gerais:

Nome Descrição Tipo Observação
versao versão do arquivo de retorno de processamento de exclusão de programação preliminar String(Obrigatório) Versão Atual: 1.00
dataProcessamento Data/Hora do registro de processamento de exclusão de programação preliminar 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 exclusão de programação preliminar String(Obrigatório)

 

Exemplos de Arquivos XML/JSON:

 

Exemplo de JSON do arquivo de exclusão de programação preliminar:

        {
            "versao":"1.00",
            "cnpjTerminal":"46591057000103",
            "porto":"BRSSZ",
            "programacaoPreliminar": 
                [
                    {
                        "seq":"0",
                        "data":"2019-12-06",
                        "janelaTempo":"1",
                    },
                    {
                        "seq":"1",
                        "data":"2019-12-06",
                        "janelaTempo":"2", 
                    }
                ]
        }

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

        {
            "dataProcessamento" : "2019-12-05T18:10:52.417-03:00",
            "itemProcessado" : 
                [ 
                    {
                        "mensagem" : [ "[IN0208] Registro processado com sucesso" ],
                        "seq" : 0
                    }, 
                    {
                        "mensagem" : [ "[IN0208] Registro processado com sucesso" ],
                        "seq" : 1
                    } 
                ],
            "versao" : "1.00"
        }

Exemplo de retorno de JSON com resposta de erro:

        {
            "dataProcessamento" : "2019-12-05T18:13:09.741-03:00",
            "itemProcessado" : 
                [
                     {
                        "mensagem" : [ "[ER0167] A janela de tempo informada é inválida" ],
                        "seq" : 0
                     }, 
                     {
                        "mensagem" : [ "[ER0184] Programação Preliminar Inexistente." ],
                        "seq" : 1
                     }
                ],
            "versao" : "1.00"
        }

Exemplo de XML do arquivo de exclusão de programação preliminar:

    <?xml version="1.0" encoding="utf-8"?>
        <programacoesPreliminares versao="1.00" xmlns="http://www.portosempapel.gov.br/programacaoPreliminar" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/programacaoPreliminar exclusaoProgPrel_v1.00.xsd ">
            <cnpjTerminal>04291660000120</cnpjTerminal>
            <porto>BRVIX</porto>
            <programacaoPreliminar seq="0001">
                <data>2019-12-12</data>
                <janelaTempo>001</janelaTempo>
            </programacaoPreliminar>
            <programacaoPreliminar seq="0002">
                <data>2019-12-12</data>
                <janelaTempo>002</janelaTempo>
            </programacaoPreliminar>
        </programacoesPreliminares>

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

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <loteExclusaoProcessado xmlns="http://www.portosempapel.gov.br/programacaoPreliminar" versao="1.00">
            <dataProcessamento>2019-12-05T18:26:00.206-03:00</dataProcessamento>
            <itemProcessado seq="0">
                <mensagem>[IN0208] Registro processado com sucesso</mensagem>
            </itemProcessado>
        </loteExclusaoProcessado>

Exemplo de retorno de XML com resposta de erro:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <loteExclusaoProcessado xmlns="http://www.portosempapel.gov.br/programacaoPreliminar" versao="1.00">
            <dataProcessamento>2020-01-15T12:52:45.350-03:00</dataProcessamento>
            <itemProcessado seq="0">
                <mensagem>[ER0167] A janela de tempo informada é inválida</mensagem>
            </itemProcessado>
        </loteExclusaoProcessado>