Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
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; | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| unblockReleasedTrips | unblockReleasedTrip[] | Sim | N/A | Elemento de agrupamento de todas as solicitações de desbloqueio de viagens; | |
| Âncora | ||||
|---|---|---|---|---|
|
| unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações | ||||||||||||||||||||||||
| identifier (unblock release trip) | Numérico (inteiro) | Sim | 10 | ID 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"; | ||||||||||||||||||||||||
| ERPMessageResponses (início) | Entidade | Não | N/A | Entidade de agrupamento das respostas do sistema externo; | |||||||||||||||||||||||||
| eRPMessageResponseList (início) | Entidade | Não | N/A | Entidade de agrupamento das respostas do sistema externo; | |||||||||||||||||||||||||
| ERPMessageResponses (início) | ERPMessageResponse[]Lista | Sim | N/A | Entidade de agrupamento das respostas do sistema externo; | eRPMessageResponse (início) | ||||||||||||||||||||||||
| orderBreakResponses | orderBreakResponse[]Entidade | Não | N/A | Entidade de agrupamento de uma resposta do sistema externo; | msg | Alfanumérico | Sim | N/A | Mensagem de resposta do sistema externo; | eRPMessageResponse (fim) | Entidade | Não | N/A | Entidade de agrupamento de uma resposta do sistema externo; | ERPMessageResponses (fim) | Lista | Sim | N/A | Entidade de agrupamento das respostas do sistema externo; | eRPMessageResponseList (fim) | Entidade | Não | N/A | Entidade de agrupamento das respostas do sistema externo; | ERPMessageResponses (fim) | Entidade | Não | N/A | Entidade de agrupamento das respostas do sistema externo; |
| orderBreakRemovalRequests (início) | Entidade | Não | N/A | Entidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakRemovalRequestList (início) | Entidade | Não | N/A | Entidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakRemovalRequests (início) | Lista | Sim | N/A | Entidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | orderBreakRemovalRequest (início) | Entidade | Sim | N/A | Entidade de agrupamento de uma solicitação do sistema externo para o cancelamento de uma quebra do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||
| identifier (order break removal) | Alfanumérico | Sim | 10 | ID da solicitação do sistema externo para o cancelamento de uma quebra do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakIdList (início) | Entidade | Sim | N/A | Entidade de agrupamento das quebras do CPL que devem ser canceladas; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakIds | Lista <numérico(inteiro)> | Sim | 10 | IDs das quebras do CPL que devem ser canceladas; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakIdList (fim) | Entidade | Sim | N/A | Entidade de agrupamento das quebras do CPL que devem ser canceladas; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente; | |||||||||||||||||||||||||||||
| tripReleaseResponses | tripReleaseResponse[] | orderBreakRemovalRequest (fim) | Entidade | Sim | N/A | Entidade de agrupamento de uma solicitaçãoresposta do sistema externo para o cancelamentoas liberações de uma quebraviagem do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | orderBreakRemovalRequests (fim) | Lista | ||||||||||||||||||||
| tripLoadsSourceIds | tripLoadsSourceId[] | SimNão | N/A | Entidade de agrupamento para envio dos source ids das solicitações cargas do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakRemovalRequestList (fim) | Entidade | Não | N/A | Entidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakRemovalRequests (fim) | Entidade | Não | N/A | Entidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL; | Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado; | ||||||||||||||||||||||||
| orderBreakResponses (início) | Entidade | Não | N/A | Entidade de agrupamento das respostas do sistema externo para as quebras do CPL; | Os desbloqueios das quebras poderão ser enviados de forma gradual (em mensagens distintas); IMPORTANTE: todas as quebras deverão ser desbloqueadas para que a viagem seja liberada; | orderBreakResponses (início) | Lista | Sim | N/A | Entidade de agrupamento das respostas do sistema externo para as quebras do CPL; | orderBreakResponse (início) | Entidade | Não | N/A | Entidade 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;||||||||||||||
Âncora eRPMessageResponse eRPMessageResponse
| ERPMessageResponse, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| msg | Alfanumérico | Sim | N/A | Mensagem de resposta do sistema externo; | |
Âncora orderBreakResponse orderBreakResponse
| orderBreakResponse , tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | Alfanumérico | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| breakId | Numérico (inteiro) | Sim | 10 | ID 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; |
| orderId | Alfanumérico | Sim | 30 | ID 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"; |
| orderItemId | Alfanumérico | Sim | 30 | ID 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; |
| status | Booleano | Sim | 1 | Status de resposta do sistema externo sobre a quebra do CPL; | 0=Quebra não realizada; 1=Quebra realizada; |
| msg | Alfanumérico | Não | 500 | Mensagem de resposta do sistema externo sobre a quebra do CPL; | |
| Âncora | ||||
|---|---|---|---|---|
|
Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;
Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;
Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do CPL;
| tripReleaseResponse, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | Alfanumérico | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| tripCode | Numérico (inteiro) | Sim | 10 | ID 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; |
| orderSourceId | Alfanumérico | Sim | 30 | ID do pedido de transporte associado à viagem; | Este campo deve receber um ID de pedido válido para a viagem; |
| itemId | Alfanumérico | Sim | 30 | ID 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; |
| status | Booleano | Não | 1 | Status 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; |
| msg | Alfanumérico | Não | 500 | Mensagem de resposta do sistema externo sobre a viagem do CPL; |
Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;
Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do CPL;
Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;
Âncora tripLoadsSourceId tripLoadsSourceId
| tripLoadsSourceId, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | Alfanumérico | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| tripId | Numérico (inteiro) | Sim | 10 | ID de uma viagem do CPL; | |
| loads | load[] | Sim | N/A | Elemento 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 | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| loadId | Numérico (inteiro) | Sim | 10 | ID 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; |
| loadSourceId | Numérico (inteiro) | Sim | 30 | ID da carga da viagem no sistema externo; | |
Layout de Resposta
Catalogo de erros
Anexos
Anexos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas