Ir para o conteúdo

Web service Portolog: Inclusão/Alteração de Cadastro de Pessoa de Origem da Carga

Serviço web que processa os pedidos de inclusão e alteração de cadastros de Pessoa de Origem da Carga. Estes cadastros são utilizados para informar no DL-e os dados da pessoa física que estufou a carga que irá ser encaminhada ao porto. Utilizada somente nos processos logísticos de Exportação, Cabotagem de Origem ou Entrada de Carga.

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/pessoa-origem-carga/nova/v1.00

Content-Type:

application/xml ou application/json

Parâmetros da Requisição de Inclusão/Alteração de Cadastro de Pessoa de Origem da Carga:

Dados Gerais:

Nome Descrição Tipo Tamanho Local Observações
versao versão do arquivo de inclusão/alteração de cadastro de empresa de origem da carga String(Obrigatório) 4 body Versão Atual: 1.00
cnpjEmissor CNPJ do Sistema Externo que está solicitando a inclusão/alteração de cadastro de empresa de origem da carga String(Obrigatório) 14 body

Lista de Pessoas de Origem da Carga:

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
tipoMovimento Tipo de Movimento: Cadastramento ou Alteração String(Obrigatório) 1 body Domínio:
C = Cadastramento,
A = Alteração
cpf CPF da Pessoa de Origem String(Obrigatório) 11 body
nome Nome da Pessoa de Origem String(Obrigatório) 100 body
inscricaoEstadual Inscrição Estadual da Pessoa de Origem String(Opcional) 15 body

Campos de Endereço da Pessoa de Origem:

Nome Descrição Tipo Tamanho Local Observações
cep CEP do Endereço Numeric(Opcional) 8 body
logradouro Logradouro do Endereço String(Opcional) 100 body
numero Número do Local no Endereço String(Opcional) 6 body
complemento Complemento do Endereço String(Opcional) 50 body
telefone Número do telefone da pessoa String(Opcional) 15 body
bairro Identificação do Bairro do Endereço String(Opcional) 50 body
email endereço de email da pessoa String(Opcional) 50 body
codMunicipio Código do município, disponível na base de dados do IBGE e que define os campos "Estado" e "Município" dentro do cadastro de endereço da pessoa Numeric(Opcional) 7 body (*) Campo obrigatório somente na inclusão do cadastro da pessoa de origem.

Domínio: Vide campo "observação" logo abaixo.

Observação:

A relação dos códigos dos municípios pode ser baixada no seguinte endereço: https://sidra.ibge.gov.br/territorio#/N6.

 

Resposta da Requisição:

Dados Gerais:

Nome Descrição Tipo Observação
versao Versão do Arquivo de Retorno de inclusão/alteração de cadastro de pessoa de origem da carga String(Obrigatório) Versão Atual: 1.00
dataProcessamento Data/Hora do Registro de Processamento de inclusão/alteração de cadastro de pessoa de origem da carga Data/Hora(Obrigatório)

Dados dos Registros:

Nome Descrição Tipo Observação
seq Sequencial do registro dentro do arquivo Numeric(Obrigatório)
mensagem Mensagem de confirmação ou erro no processamento de inclusão/alteração de cadastro de pessoa de origem da carga String(Obrigatório)
pontoControle Código do Ponto de Controle da Pessoa de Origem. String(Opcional) (*) Campo exibido somente quando a pessoa de origem for cadastrada com sucesso ou quando a mesma já estiver cadastrada.

 

Exemplos de Arquivos XML/JSON:

 

Exemplo de JSON do arquivo de Inclusão/Alteração de Cadastro de Pessoa de Origem da Carga:

      {
            "versao":"1.00",
            "cnpjEmissor":"04291660000120",
            "POC": [
                {
                    "seq": 0,
                    "tipoMovimento":"C",
                    "cpf":"50680686088",
                    "nome":"Michael Jackson",
                    "endereco":
                        {
                            "cep":88080130,
                            "logradouro":"Rua das Estrelas",
                            "numero":"123",
                            "telefone":"2107-8555",
                            "bairro":"WonderLand",
                            "codMunicipio":3518701,
                            "email": "jackson@michael.com"
                        }
                }

            ]
      }

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

        {
            "dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
            "versao":"1.00",
            "pocProc" : [ 
                {
                    "mensagem" : [ "[IN0208] Registro processado com sucesso" ],
                    "pontoControle" : "PE00299",
                    "seq" : 0
                }
            ]
        }

Exemplo de retorno de JSON com resposta de erro:

        {
            "dataProcessamento" : "2019-11-13T14:50:51.945-03:00",
            "versao":"1.00",
            "mensagem" : [ "[ER0169] O arquivo de lote possui sequenciais duplicados." ]
        }

Exemplo de XML do arquivo de Inclusão/Alteração de Cadastro de Pessoa de Origem da Carga:

    <?xml version="1.0" encoding="UTF-8"?>
    <lotePOC versao="1.00" xmlns="http://www.portosempapel.gov.br/poc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.portosempapel.gov.br/poc PessoaOrigem_v1.00.xsd ">
        <cnpjEmissor>04291660000120</cnpjEmissor>
        <POC seq="0">
            <tipoMovimento>C</tipoMovimento>
            <cpf>38750778900</cpf>
            <nome>José Wilker</nome>
            <endereco>
                <cep>88085150</cep>
                <logradouro>Rua dos Desesperados</logradouro>
                <numero>450</numero>
                <telefone>(11)3035-5750</telefone>
                <bairro>Moema</bairro>
                <codMunicipio>3518701</codMunicipio>
            </endereco>
        </POC>
    </lotePOC>

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

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <lotePOCProc xmlns="http://www.portosempapel.gov.br/poc" versao="1.00">
        <dataProcessamento>2020-01-17T14:10:36.508-03:00</dataProcessamento>
        <pocProc seq="0">
            <mensagem>[IN0208] Registro processado com sucesso</mensagem>
            <pontoControle>PE00238</pontoControle>
        </pocProc>
    </lotePOCProc>

Exemplo de retorno de XML com resposta de erro:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <lotePOCProc xmlns="http://www.portosempapel.gov.br/poc" versao="1.00">
        <dataProcessamento>2020-01-17T14:10:36.508-03:00</dataProcessamento>
        <pocProc seq="0">
            <mensagem>[ER0273] O CPF informado já está cadastrado.</mensagem>
            <pontoControle>PE00238</pontoControle>
        </pocProc>
    </lotePOCProc>