Web service Portolog: Consulta de Eventos em Puxada de Carga
Serviço web que retorna a informação das entradas e saídas de transportes nos seus respectivos pontos de controle de puxada de carga. Os pontos de puxada de carga são pátios reguladores ao longos das vias que funcionam como uma espécie de "buffer" a fim de evitar filas nos acessos aos portos, liberando os caminhões de acordo com os seus horários agendados. Os pontos de puxada de carga são informados na criação ou alteração de um DL-e.
Atores que podem utilizar o Serviço:
- Operador Portuário
- Terminal Portuário
- Autoridade Portuária
- Ponto de Controle
Endpoint do Serviço:
POST url_base/psp-portolog-rest/api/dle/evento-em-puxada/v1.00
Content-Type:
application/xml ou application/json
Parâmetros da Requisição de Consulta:
| Nome | Descrição | Tipo | Tamanho | Local | Observações |
|---|---|---|---|---|---|
| versao | versão do arquivo de consulta de eventos em puxada de carga | String(Obrigatório) | 4 | body | Versão Atual: 1.00 |
| numeroDle | Número do DL-e associado ao registro de entrada/saída em puxada. | Numeric(Opcional) | 12 | body | |
| pontoPuxadaCod | Código do Ponto de Controle de Puxada de Carga do DL-e | String(Opcional) | 7 | body | Domínio: Vide campo "observação" logo abaixo. |
| placa | Placa do Veículo | String(Opcional) | 7 | body | |
| dataEvento | Data do evento de entrada/saída em puxada. | Data(Obrigatório) | 10 | body | Formato: AAAA-MM-DD. |
Observação:
Para acesso às informações dos códigos de pontos de controle de puxada de carga que atendem ao seu terminal, favor consultar através do acesso à tela do Portolog, no menu "Serviços" e item de menu "Informações para Integração" selecionando o tipo "Ponto de Controle". Os códigos dos pontos de puxada serão iniciados sempre com "PI".
Resposta da Requisição:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| versao | versão do arquivo de retorno da consulta de eventos em puxada | String(Obrigatório) | Versão Atual: 1.01 |
| numeroDle | Número do DL-e associado ao registro de entrada/saída em puxada. | Numeric(Obrigatório) | |
| dataEvento | Data/Hora do evento de entrada/saída em puxada. | Data/Hora(Obrigatório) | Formato: AAAA-MM-DDTHH:MM:SS. |
| tipoEvento | Tipo do evento em puxada. | String(Obrigatório) | Domínio: - Entrada - Saída |
| porto | Bitrigrama do porto de destino do transporte | String(Obrigatório) | |
| terminal | CNPJ do terminal de destino do transporte | String(Obrigatório) | |
| pontoPuxada | Código do Ponto de Controle de Puxada de Carga do DL-e | String(Obrigatório) | |
| dataInicialEntradaPorto | Data/Hora agendada de entrada no porto | Data/Hora(Opcional) | Formato: AAAA-MM-DDTHH:MM:SS.sssZZZ Exemplo:2020-12-30T09:30:00.000-03:00 (*)Campo exibido somente quando o DL-e estiver sequenciado. |
| dataFinalEntradaPorto | Data/Hora agendada de entrada no porto somado ao tempo de tolerância cadastrado no cadastro do porto. | Data/Hora(Opcional) | Formato: AAAA-MM-DDTHH:MM:SS..sssZZZ (*)Campo exibido somente quando o DL-e estiver sequenciado. |
Dados do Veículo:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| tipoVeiculo | Tipo do Veículo | String(Obrigatório) | Domínio: - Tração - Reboque |
| placa | Placa do Veículo | String(Obrigatório) | |
| tagEletronica | Identificação Eletrônica do Transporte | String(Opcional) | |
| tara | Peso do Veículo medido em kilogramas | String(Opcional) |
Dados do Motorista:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| cpf | CPF do motorista | String(Opcional) | |
| nome | Nome do motorista | String(Opcional) |
Lista de Contêineres(Encaminhada somente quando o tipo de carga for contêiner):
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| numeroConteiner | Placa do Veículo | String(Opcional) | |
| tag | Identificação Eletrônica da Carga | String(Opcional) |
Observação:
O retorno da consulta, a depender do ator que encaminhou a requisição, seguirá a seguinte regra:
- Operador ou Terminal: Somente receberá retornos de eventos em puxada referentes aos DL-es destinados ao seu terminal
- Ponto de Controle: Somente receberá retornos de eventos em puxada referentes ao seu ponto de controle
- Autoridade Portuária: Somente receberá retornos de eventos em puxada referentes aos DL-es destinados ao seu Porto
Exemplos de Arquivos XML/JSON:
Exemplo de JSON da requisição de consulta:
{
"versao": "1.00",
"numeroDle": 992020,
"pontoPuxadaCod": "PI00001",
"dataEvento": "2020-03-02"
}
Exemplo de JSON com a resposta da requisição:
{
"versao": "1.01",
"eventoPuxada":
[
{
"porto": "BRSSZ",
"terminal": "82951351000142",
"numeroDle": 992020,
"dataEvento": "2020-03-02T11:07:00.000-03:00",
"tipoEvento": "ENTRADA",
"pontoPuxada": "PI00001",
"dataInicialEntradaPorto":"2020-03-02T14:30:00.000-03:00",
"dataFinalEntradaPorto":"2020-03-02T19:30:00.000-03:00",
"veiculo": [
{
"tipoVeiculo":"TRACAO",
"placa":"TES1W34"
}
],
"motorista": [
{
"cpf":"30784350086",
"nome":"Zé Buscapé",
}
]
},
{
"porto": "BRSSZ",
"terminal": "82951351000142",
"numeroDle": 992020,
"dataEvento": "2020-03-02T12:30:00.000-03:00",
"tipoEvento": "SAIDA",
"pontoPuxada": "PI00001",
"dataInicialEntradaPorto":"2020-03-02T14:30:00.000-03:00",
"dataFinalEntradaPorto":"2020-03-02T19:30:00.000-03:00",
"veiculo": [
{
"tipoVeiculo":"TRACAO",
"placa":"TES1W34"
}
],
"motorista": [
{
"cpf":"30784350086",
"nome":"Zé Buscapé",
}
]
}
]
}
Exemplo de JSON com resposta de erro:
{
"dataProcessamento" : "2020-02-25T18:10:52.417-03:00",
"mensagem" : [ "[IN0010] Não existem registros para os parâmetros informados." ],
"versao": "1.01"
}
Exemplo de XML da requisição de consulta:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventoPuxadaFiltro versao="1.00">
<numeroDle>6552020</numeroDle>
<pontoPuxadaCod>PI00009</pontoPuxadaCod>
<dataEvento>2020-02-06</dataEvento>
</eventoPuxadaFiltro>
Exemplo de XML com a resposta da requisição:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventosPuxada versao="1.01">
<eventoPuxada>
<numeroDle>6552020</numeroDle>
<dataEvento>2020-02-06T13:01:48.000-03:00</dataEvento>
<tipoEvento>SAIDA</tipoEvento>
<porto>BRVIX</porto>
<terminal>04291660000120</terminal>
<pontoPuxada>PI00009</pontoPuxada>
<veiculo>
<tipoVeiculo>TRACAO</tipoVeiculo>
<placa>NIF7I8S</placa>
</veiculo>
<motorista>
<nome>Teste</nome>
<cpf>22222222222</cpf>
</motorista>
</eventoPuxada>
<eventoPuxada>
<numeroDle>6552020</numeroDle>
<dataEvento>2020-02-06T10:00:48.000-03:00</dataEvento>
<tipoEvento>ENTRADA</tipoEvento>
<porto>BRVIX</porto>
<terminal>04291660000120</terminal>
<pontoPuxada>PI00009</pontoPuxada>
<veiculo>
<tipoVeiculo>TRACAO</tipoVeiculo>
<placa>NIF7I8S</placa>
</veiculo>
<motorista>
<nome>Teste</nome>
<cpf>22222222222</cpf>
</motorista>
</eventoPuxada>
</eventosPuxada>
Exemplo de XML com a resposta de erro:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventosPuxada versao="1.01">
<dataProcessamento>2020-02-25T18:10:52.417-03:00</dataProcessamento>
<mensagem>[ER0174] Não foi localizado o identificador do ponto de controle informado</mensagem>
</eventosPuxada>