Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
pageId607602837
diagramDisplayName
lboxtrue
diagramNameTRE_Liberacao_viagem
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth480

Sistemas EnvolvidosEnvolvidos 

Integração

Escopo

Pré-requisitos instalação/implantação/utilização

Layout de Requisição

Âncora
doUnblockReleasedTrip
doUnblockReleasedTrip

doUnblockReleasedTrip: Integração SOAP, Assíncrona com a publishReleasedTrip;
NomeTipoObrigatórioTamanhoDescriçãoObservações
unblockReleasedTripsunblockReleasedTrips[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
unblockReleasedTrips
unblockReleasedTrips

unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
unblockReleasedTripsunblockReleasedTrip[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;
Âncora
unblockReleasedTrip
unblockReleasedTrip
unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
identifier (unblock release trip)Numérico (inteiro)Sim10ID da mensagem de solicitação de liberação da viagem;

Este campo deve ser de uma mensagem de solicitação de liberação de viagem válida ou -1 quando ocorrer algum erro no sistema externo ao tentar recriar as viagens do CPL (neste caso, a requisição feita neste serviço será ignorada pelo CPL); no caso de erro no sistema externo, o detalhe deste erro pode ser enviado no elemento "ERPMessageResponses";

ERPMessageResponseseRPMessageResponseList[]NãoN/AEntidade de agrupamento das respostas do sistema externo;
orderBreakResponses

orderBreakResponses[]

NãoN/AEntidade de agrupamento de uma resposta do sistema externo para uma quebra do CPL;Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente;
tripReleaseResponsestripReleaseResponseList[]SimN/A

Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do CPL;


tripLoadsSourceIdstripLoadsSourceIdList[]SimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;

Âncora
eRPMessageResponseList
eRPMessageResponseList

eRPMessageResponseList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
ERPMessageResponseseRPMessageResponse[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
eRPMessageResponse
eRPMessageResponse

eRPMessageResponse, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
msgAlfanuméricoSimN/AMensagem de resposta do sistema externo;

Âncora
orderBreakResponses
orderBreakResponses

orderBreakResponses, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
orderBreakResponsesorderBreakResponse[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
orderBreakResponse
orderBreakResponse

orderBreakResponse , tipo de dado utilizado nas integrações do TRE

Nome

TipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdAlfanuméricoSim30Identificador da regional;Deve ser uma regional válida;
breakIdNumérico (inteiro)Sim10ID da quebra do CPL;

Este campo deve receber um ID de quebra válido; não se deve re-enviar IDs de quebra que já foram liberados; o sistema externo deverá dar um retorno para todos os breakIds gerados pelo CPL na interface de liberação de viagem para que esta seja liberada;

orderIdAlfanuméricoSim30ID do pedido de transporte associado à quebra;Importante:
- Caso o sistema externo deseja que esta quebra seja vinculada a um novo pedido, basta informar o nome do novo pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo pedido; os dados do novo pedido serão copiados do pedido original;
- Esta alteração do pedido apenas será realizada se o campo status for enviado com o valor "1";
orderItemIdAlfanuméricoSim30ID do item do pedido de transporte associado à quebra;Importante:
- Caso o sistema externo deseja que esta quebra seja vinculada a um novo item de pedido, basta informar o nome do novo item pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo item de pedido; os dados do novo item de pedido serão copiados do item de pedido original;
- Esta alteração do item do pedido apenas será realizada se o campo status for enviado com o valor "1";
- Se o código do item de pedido for alterado mas o código de pedido permanecer o mesmo do pedido original, a mensagem será rejeitada;
statusBooleanoSim1Status de resposta do sistema externo sobre a quebra do CPL;0=Quebra não realizada; 1=Quebra realizada;
msgAlfanuméricoNão500Mensagem de resposta do sistema externo sobre a quebra do CPL;

Âncora
tripReleaseResponseList
tripReleaseResponseList

tripReleaseResponseList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripReleaseResponseListtripReleaseResponse[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;
Âncora
tripReleaseResponse
tripReleaseResponse
tripReleaseResponse, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdAlfanuméricoSim30Identificador da regional;Deve ser uma regional válida;
tripCodeNumérico (inteiro)Sim10ID da viagem do CPL;Este campo deve receber um ID de viagem válido; não se deve enviar IDs de viagens que já foram liberadas;
orderSourceIdAlfanuméricoSim30ID do pedido de transporte associado à viagem;Este campo deve receber um ID de pedido válido para a viagem;
itemIdAlfanuméricoSim30ID do item do pedido de transporte associado ao pedido da viagem;Este campo deve receber um ID de item de pedido válido para o pedido da viagem; o sistema externo deverá dar um retorno para todos os itens de pedido existentes na viagem para que esta seja liberada;
statusBooleanoNão1Status de resposta do sistema externo sobre a viagem do CPL;0=Não desbloqueia a viagem; 1=Desbloqueia a viagem; se este campo não for preenchido, ele será considerado como 0;
msgAlfanuméricoNão500Mensagem de resposta do sistema externo sobre a viagem do CPL;

Âncora
tripLoadsSourceIdList
tripLoadsSourceIdList

tripLoadsSourceIdList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripLoadsSourceIdstripLoadsSourceId[]SimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;

Âncora
tripLoadsSourceId
tripLoadsSourceId

tripLoadsSourceId, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdAlfanuméricoSim30Identificador da regional;Deve ser uma regional válida;
tripIdNumérico (inteiro)Sim10ID de uma viagem do CPL;
loadsload[]SimN/AElemento de agrupamento de todas as cargas da viagem;Quando enviada, esta seção deverá retornar todas as cargas da viagem;

Âncora
load
load

load, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadIdNumérico (inteiro)Sim10ID da carga da viagem no CPL;

Estes campos são apenas para que se possa ter uma referência do ID de uma carga do sistema externo no CPL; se o loadId não for válido (ex.: vazio ou um código inexistente no CPL) ou estiver associada a uma viagem distinta da informada, o CPL deverá retornar uma mensagem de erro e a requisição deverá ser ignorada;

loadSourceIdNumérico (inteiro)Sim30ID da carga da viagem no sistema externo;

Layout de Resposta

tripLoadsSourceIdList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultresults[]SimN/AEntidade de agrupamento para envio dos resultados
Âncora
results
results
results, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultsresult[]SimN/AEntidade de agrupamento para envio dos resultados
Âncora
result
result
result, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
errorCodeserrcode[]NãoN/ALista de erros
errorMessageAlfanuméricoNãoN/AMensgem de erro
identifierAlfanuméricoSimN/AID da mensagem de solicitação de liberação da viagem;
sucessAlfanuméricoSim1TRUE or FALSE
Âncora
errcode
errcode
errcode, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
valueAlfanuméricoNãoN/ACódigo do erro

Catalogo de erros

Anexos

Anexos