Histórico da Página

Introdução

draw.io Diagram

A interface publishCancelService serve apenas para solicitar ao sistema externo permissão para o cancelamento da carga no TOL\TRE.
- Para solicitar esta permissão, o TOL\TRE irá mandar uma mensagem ao sistema externo através da estrutura publishCancelService e o sistema externo deverá retornar uma mensagem de resposta ao TOL\TRE na estrutura publishCancelServiceResponse:
  - Se o sistema externo retornar um status de que o cancelamento é possível (campo status=0), o TOL\TRE permitirá ao usuário a alteração da carga.
  - Se o sistema externo retornar um status de que cancelamento não é possível (campo status=1 ou 2 ou 3 ou 4), o TOL\TRE não permitirá ao usuário a alteração da carga.

Âncora

	publishCancelService
	publishCancelService

publishCancelService, Integração SOAP, Síncrona
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
regionSourceId	String	Sim	30	Identificador da regional;	Deve ser uma regional válida;
basketSourceId	String	Não	30	ID da cesta onde esta operação foi realizada manualmente pelo usuário;	Este campo poderá não ser enviado nos casos em que o cancelamento foi feito de forma automática e não manualmente por um usuário através das telas (nestes casos, não se pode identificar a cesta do usuário); Os seguintes exemplos podem gerar mensagens de cancelamento automáticas para o sistema externo sem a informação da cesta do usuário: - Se um usuário que possui viagens não desbloqueadas é removido, nesta remoção suas viagens serão canceladas; - Uma doca associada a viagens não desbloqueadas é removida, nesta remoção suas viagens serão canceladas; - Um pedido é removido de forma automática (via integração) fazendo com que viagens não desbloqueadas fiquem sem DUs, forçando que estas sejam canceladas;
trips	trip[]	Sim	N/A	Elemento de agrupamento de todas as viagens que se quer cancelamento ;	Deverá haver pelo menos 1 viagem nesta lista;
loads	load[]	Sim	N/A	Elemento de agrupamento de todas as cargas da viagem;

Âncora

	trip
	trip

trip, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
tripId	int	Sim	10	ID da viagem cujo cancelamento está sendo solicitado;

Âncora

	load
	load

load, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
loadId	Integer	Sim	10	Identificador de uma carga da viagem;
loadSourceId	String	Não	30	Identificador externo de uma carga da viagem;

Âncora

	publishCancelServiceResponse
	publishCancelServiceResponse

publishCancelServiceResponse, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
result	result[]	Sim	N/A	Elemento de agrupamento de todas as viagens que se quer cancelamento com os respectivos status das solicitações;	Deverá haver pelo menos 1 viagem nesta lista;

Âncora

	result
	result

result, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
regionSourceId	String	Sim	30	Identificador da regional;	Deve ser uma regional válida;
tripId	Integer	Sim	10	ID da viagem cujo cancelamento foi solicitado;
status	Integer	Sim	1	Status da solicitação de cancelamento de viagem;	0=Viagem cancelada com sucesso; 1=Viagem já estava cancelada; 2=Viagem não encontrada; 3=Viagem já despachada; 4=Viagem não pode ser cancelada; O processo de cancelamento deverá funcionar da seguinte forma: - Ao solicitar o cancelamento da viagem (ou carga) , a interface de notificação de cancelamento de viagens (ou cargas) informará o sistema externo, se o sistema externo confirmar o cancelamento da viagem (ou carga) através dos status 0, 1 ou 2, esta também será cancelada no TOL/TRE; Importante: as delivery units das viagens canceladas serão sempre devolvidas para a cesta do respectivo usuário;

Âncora

	catmsg
	catmsg

Código

Mensagem

Descrição

Anexos