Histórico da Página
Introdução
Sistemas Envolvidos
Integração
Escopo
Pré-requisitos instalação/implantação/utilização
Layout de Requisição
- A
- interface “PublishReprogrammingService” serve apenas para solicitar ao sistema externo permissão para a reprogramação da carga no CPL.
- Para solicitar esta permissão, o CPL irá mandar uma mensagem ao sistema externo através da estrutura “publishReprogrammingServiceRequest” e o sistema externo deverá retornar uma mensagem de resposta ao CPL na estrutura “publishReprogrammingServiceResponse
- ”
- Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o CPL 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 CPL 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 CPL, o CPL irá enviar novamente ao sistema externo (através da interface “ReleasedTripPublishRequestService”) 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 CPL (que será feita através da interface “ReleasedTripPublishRequestService”).
Pré-requisitos instalação/implantação/utilização
Layout de Requisição
Âncora publishReprogrammingServiceRequest publishReprogrammingServiceRequest
| publishReprogrammingServiceRequest, Integração SOAP, Síncrona | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| publishReprogrammingService (início) | Entidade | ||||
| Sim |
| N/A |
| Elemento de agrupamento das solicitações de reprogramação de viagens do CPL ao sistema legado; | |||
| regionSourceId | Alfanumérico | Sim | 30 |
| Identificador da regional; | Deve ser uma regional válida; | ||
| basketSourceId | Alfanumérico | Não | 30 |
| ID da cesta onde esta operação foi realizada manualmente pelo usuário no CPL; | 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 CPL (nestes casos, não se pode identificar a cesta do usuário); | ||
| trips (início) | Lista | Sim | N/A |
| Elemento de agrupamento de todas as viagens do CPL que se quer reprogramar; | Deverá haver pelo menos 1 viagem do CPL nesta lista; | ||
| trip (início) | Entidade | Sim | N/A |
| Elemento de agrupamento de uma viagem do CPL; | |||
| tripId | Numérico (inteiro) | Sim | 10 |
| ID da viagem cuja reprogramação está sendo solicitada pelo CPL ao sistema legado; | ||
| loads (início) | Lista | Sim |
| N/A |
| Elemento de agrupamento de todas as cargas da viagem; | |||
| load (início) | Entidade | Sim | N/A |
| Elemento de agrupamento de uma carga da viagem; | |||
| loadId | Numérico (inteiro) | Sim | 10 |
| Identificador de uma carga da viagem; | |||
| loadSourceId | Alfanumérico | Não | 30 |
| Identificador externo de uma carga da viagem; | ||
| load (fim) | Entidade | Sim |
| N/A |
| loads (fim) | Lista | Sim |
| N/A | |||
| trip (fim) | Entidade | Sim | N/A |
| trips (fim) | Lista | Sim |
| N/A |
| publishReprogrammingService (fim) | Entidade | Sim | N/A |
Layout de Resposta
Âncora publishReprogrammingServiceResponse publishReprogrammingServiceResponse
| publishReprogrammingServiceResponse, tipo de dado utilizado nas integrações do TRE |
|---|
| Nome | Tipo | ||||
|---|---|---|---|---|---|
| Obrigatório | Tamanho | Descrição | Observações |
|---|---|---|---|
| publishReprogrammingServiceResponse (início) | Entidade | Sim | N/A |
| Elemento de agrupamento das respostas às solicitações de reprogramação de viagens do CPL ao sistema legado; | ||
| result (início) | Lista | Sim |
| N/A |
| Elemento de agrupamento de todas as viagens do CPL que se quer reprogramar com os respectivos status das solicitações; | Deverá haver pelo menos 1 viagem do CPL nesta lista; | ||
| regionSourceId | Alfanumérico | Sim | 30 |
| Identificador da regional; | Deve ser uma regional válida; | ||
| tripId | Numérico (inteiro) | Sim | 10 |
| ID da viagem cuja reprogramação foi solicitada pelo CPL ao sistema legado; | |||
| status | Numérico (inteiro) | Sim | 1 |
| Status 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; | |
| result (fim) | Lista | Sim |
| N/A |
| Elemento de agrupamento de todas as viagens do CPL que se quer reprogramar com os respectivos status das solicitações; | Deverá haver pelo menos 1 viagem do CPL nesta lista; | ||
| publishReprogrammingServiceResponse (fim) | Entidade | Sim | N/A |
Elemento de agrupamento das respostas às solicitações de reprogramação de viagens do CPL ao sistema legado; |
Catalogo de mensagens
Âncora catmsg catmsg
| Código | Mensagem | Descrição |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas