Versões comparadas

Chave

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

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision1
diagramNameTRE_reprogramação
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth343

Sistemas Envolvidos

Integração

Escopo

  • A interface PublishReprogrammingService serve apenas para solicitar ao sistema externo permissão para a reprogramação da carga no TRE.
  • Para solicitar esta permissão, o TRE irá mandar uma mensagem ao sistema externo através da estrutura publishReprogrammingServiceRequest e o sistema externo deverá retornar uma mensagem de resposta ao TRE na estrutura publishReprogrammingServiceResponse
  • Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o TRE permitirá ao usuário a alteração da carga.
  • Se o sistema externo retornar um status de que reprogramação não é possível (campo status=1 ou 2 ou 3), o TRE não permitirá ao usuário a alteração da carga.
  • Caso o sistema externo retorne que a reprogramação é possível (campo status=0), após a reprogramação da carga no TRE, o TRE irá enviar novamente ao sistema externo (através da interface publishReleasedTrip) uma mensagem de publicação de viagens com as alterações feitas pelo usuário na reprogramação.
  • Neste cenário, quando o sistema externo permitir a reprogramação da carga, é importante que o sistema externo volte o status do documento de transporte para uma condição que permita uma futura edição pelo TRE (que será feita através da interface publishReleasedTrip).

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

Layout de Requisição

Âncora
publishReprogrammingServiceRequest
publishReprogrammingServiceRequest

publishReprogrammingServiceRequest, Integração SOAP, Síncrona
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdstringSim30Identificador da regional;Deve ser uma regional válida;
basketSourceIdstringNão30ID da cesta onde esta operação foi realizada manualmente pelo usuário no TRE;Este campo poderá não ser enviado nos casos em que a solicitação de reprogramação foi feita de forma automática e não através da tela do TRE (nestes casos, não se pode identificar a cesta do usuário);
trips trip[]SimN/AElemento de agrupamento de todas as viagens do TRE que se quer reprogramar;Deverá haver pelo menos 1 viagem do TRE nesta lista;
loadsload[]SimN/AElemento de agrupamento de todas as cargas da viagem;

Âncora
trip
trip

trip, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripIdintSim10ID da viagem cuja reprogramação está sendo solicitada pelo TRE ao sistema legado;

Âncora
load
load

load, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadIdintSim10Identificador de uma carga da viagem;
loadSourceIdstringNão30Identificador externo de uma carga da viagem;

Layout de Resposta

Âncora
publishReprogrammingServiceResponse
publishReprogrammingServiceResponse

publishReprogrammingServiceResponse, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultresult[]SimN/AElemento de agrupamento de todas as viagens do TRE que se quer reprogramar com os respectivos status das solicitações;Deverá haver pelo menos 1 viagem do TRE nesta lista;
Âncora
result
result
result, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdstringSim30Identificador da regional;Deve ser uma regional válida;
tripIdintSim10ID da viagem cuja reprogramação foi solicitada pelo CPL ao sistema legado;
statusintSim1Status da solicitação de reprogramação de viagem enviada pelo CPL ao sistema legado;0=Reprogramação autorizada; 1=Viagem cancelada; 2=Viagem não encontrada; 3=Viagem já despachada/Reprogramação não autorizada;

Importante:
- Se o sistema externo retornar o código 0, a viagem será colocada no seu último status antes da liberação (Observação: notar que alguns destes status podem não permitir a reprogramação! Ex.: "Viagem Ofertada");
- Se o sistema externo retornar o código 1, o CPL irá efetuar o cancelamento da viagem automaticamente e o sistema externo
não será novamente notificado deste cancelamento pelo CPL (como foi o sistema externo que informou que a viagem já está cancelada, esta notificação extra do CPL é desnecessária;
- Se o sistema externo retornar os códigos 2 ou 3, não será possível reprogramar a viagem no CPL;

Catalogo de mensagens

Âncora
catmsg
catmsg

CódigoMensagemDescrição

Anexos

Anexos