Mensagens enviadas pelo cliente
Solicitação de nova necessidade logística (ServiceRequestMessage)
Esta mensagem representa um pedido de serviço feito por um cliente. Nela temos várias informações sobre o serviço solicitado. Entre essas informações temos:
Classe/Propriedade | Descrição |
| Id | Código da mensagem. Que deverá ser usado posteriormente para confirmar a leitura da mesma. |
| DrakeId | Código da necessidade logística da solicitação. Quando um pedido de alteração ou cancelamento for recebido, é este código que será usado para relacionar as diferentes solicitações. |
| SenderUserName | Nome do usuário que estava no Drake e que é o responsável pela solicitação. |
| LogisticNeed.DrakeId | Código da necessidade logística |
| LogisticNeed.Start | Data/hora do início da necessidade logística. |
| LogisticNeed.End | Data/hora prevista para o fim da necessidade logística. |
| LogisticNeed.Type | Tipo da necessidade logística (aluguel de carro, passagem aérea, hospedagem ou transporte rodoviário) |
| LogisticNeed.Subtype | Subtipo da necessidade logística (carro, van, ônibus, classe econômica etc). |
| LogisticNeed.Comments | Comentários sobre a necessidade logística. Alguma observação como por exemplo em qual terminal o passageiro estará etc. |
| LogisticNeed.Origin | Endereço de origem da necessidade logística. |
| LogisticNeed.Destination | Endereço de destino da necessidade logística. |
| LogisticNeed.Participant.Name | Nome do funcionário/participante da necessidade logística |
| LogisticNeed.Participant.PhoneNumbers | Telefones do funcionário/participante da necessidade logística. |
A seguir um diagrama de classes da mensagem de solicitação de nova necessidade logística com todas as propriedades e relacionamentos:
...
.png?version=1&modificationDate=1559047749098&cacheVersion=1&api=v2)
Observação: Uma necessidade logística pode conter outras necessidades logísticas agregadas a esta. Isto ocorre sempre que o cliente decidir agrupar algumas necessidades logísticas como por exemplo usar um mesmo carro, van, ou quarto de Hotel para atender a várias necessidades logísticas de participantes distintos. Neste caso, a propriedade Associated da necessidade logística contém as necessidades que foram associadas e que serão atendidas por um mesmo carro, van, ou quarto de hotel.
Solicitação de alteração de necessidade logística (ChangeRequestMessage)
Esta mensagem representa uma solicitação de alteração de uma necessidade logística. Em geral os pedidos de alteração envolvem mudança de data/horário, de endereço e inclusão ou remoção de um participante/funcionário. A mensagem é semelhante ao pedido de nova solicitação, porém o tipo da mensagem é ChangeRequest.
A informação presente na propriedade DrakeId deve ser usada pelo fornecedor para identificar qual é a necessidade que o cliente gostaria de solicitar alteração.
A seguir um diagrama de classes da mensagem de solicitação de alteração de necessidade logística com todas as propriedades e relacionamentos:
...
.png?version=1&modificationDate=1559047757041&cacheVersion=1&api=v2)
Solicitação de cancelamento de necessidade logística (CancelationRequestMessage)
Esta mensagem representa uma solicitação de cancelamento de uma necessidade logística. Quando uma mensagem deste tipo for recebida, significa que o cliente não precisa mais da necessidade anteriormente solicitada e com isto gostaria que fosse cancelada.
Nesta mensagem temos a propriedade DrakeId que deverá ser usada pelo fornecedor para identificar qual é a necessidade que o cliente gostaria de solicitar o cancelamento.
A seguir um diagrama de classes da mensagem de solicitação de cancelamento de necessidade logística com todas as propriedades relacionadas:
Esta mensagem representa uma solicitação de cancelamento de uma necessidade logística. Quando uma mensagem deste tipo for recebida, significa que o cliente não precisa mais da necessidade anteriormente solicitada e com isto gostaria que fosse cancelada.
Nesta mensagem temos a propriedade DrakeId que deverá ser usada pelo fornecedor para identificar qual é a necessidade que o cliente gostaria de solicitar o cancelamento.
A seguir um diagrama de classes da mensagem de solicitação de cancelamento de necessidade logística com todas as propriedades relacionadas:
...
.png?version=1&modificationDate=1559047775491&cacheVersion=1&api=v2)
Mensagens enviadas pelo fornecedor
Confirmação de atendimento de necessidade logística (ConfirmServiceMessage)
Esta mensagem representa uma confirmação de atendimento de uma necessidade logística feita pelo fornecedor. Nela temos várias informações sobre o serviço confirmado. Entre essas informações temos:
Classe/Propriedade | Descrição | Obrigatória |
| DrakeId | Código da necessidade logística da solicitação que está sendo confirmada. | SIM |
| SenderUserName | Nome do usuário responsável pela confirmação do serviço. | |
| Details | Comentários sobre o serviço. Nome do motorista, placa do carro, número do voo etc. | |
| Origin | Endereço de origem da necessidade logística. Caso seja igual ao informado na solicitação, basta não informar. | |
| Destination | Endereço de destino da necessidade logística. Caso seja igual ao informado na solicitação, basta não informar. | |
| Start | Data de início do atendimento da necessidade logística. | SIM |
| End | Data de término do atendimento da necessidade logística. | SIM |
| ExternalId | Código do atendimento no sistema do fornecedor. | SIM |
| Value | Valor do atendimento. | |
| Fees | Taxas do atendimento. | |
| RebatesByReuse | Descontos aplicados caso esteja utilizando algum outro atendimento reutilizável. | |
| Comission | Comissão. | |
| TrackingLink | Link de rastreamento (Link Web). Utilizado em geral para informar onde um carro/van está através de sistema GPS em tempo real. | |
| ReservationNumber | Código de reserva. Em geral utilizado para bilhetes rodoviários ou passagens aéreas (código do localizador). | |
| Provider | Provedor do serviço. Exemplos: Auto Viação 1001, TAM, GOL, AVIANCA etc. Caso o provedor seja o próprio fornecedor, deverá informar o nome do mesmo. | SIM |
A seguir um diagrama de classes da mensagem de confirmação de atendimento de necessidade logística com todas as propriedades e relacionamentos:
...
.png?version=1&modificationDate=1559047793070&cacheVersion=1&api=v2)
Confirmação de cancelamento total (CancelationConfirmationMessage)
Esta mensagem representa uma confirmação de cancelamento feita pelo fornecedor. Deverá ser usada pelo fornecedor quando o mesmo desejar confirmar um pedido de cancelamento de um atendimento sem custo para o cliente. Nela basta informar o código (DrakeId) da necessidade logística.
Em geral este tipo de mensagem é enviada por fornecedores de transporte terrestre (carros e vans), pois normalmente não é cobrada uma taxa para cancelamento de um serviço que ainda não foi prestado e que não gerou custo para o fornecedor.
Confirmação de cancelamento com reembolso (CancelationConfirmationWithRefundMessage)
Esta mensagem representa uma confirmação de cancelamento com reembolso feita pelo fornecedor. Deverá ser usada pelo fornecedor quando o mesmo desejar confirmar um pedido de cancelamento de um atendimento, porém será cobrado o valor do atendimento ao cliente e posteriormente será reembolsado ao cliente parte do valor pago. Nesta mensagem basta informar o código (DrakeId) da necessidade logística e o valor estimado do reembolso (RefundValue).
Em geral este tipo de mensagem é enviada por for agências de viagens que compram bilhetes de transporte aéreo. Neste cenário, a necessidade é cancelada com reembolso. Ao final do período financeiro, o fornecedor informará quais necessidades logísticas foram reembolsadas (via desconto em nota fiscal ou deposito bancário) e o cliente dará baixa no reembolso dentro do Drake informando qual foi o valor real do reembolso (visto que o valor inicialmente informado pelo fornecedor é estimado).
Dentro do Drake, as necessidades canceladas com reembolso podem ser reutilizadas até que prazo máximo de reuso da mesma seja atingido. Neste caso o fornecedor não irá reembolsar o valor do atendimento, mas sim deixa-rá o mesmo em aberto como crédito futuro para uma compra de passagem aérea, por exemplo.
Recusa de cancelamento (RefuseCancelationMessage
Esta mensagem representa uma recusa de cancelamento feita pelo fornecedor. Deverá ser usada pelo fornecedor quando o mesmo deseja recusar um pedido de cancelamento de um atendimento. Nesta mensagem basta informar o código (DrakeId) da necessidade logística. Ao fazer isto o fornecedor estará informando que não poderá cancelar o atendimento e que o valor do mesmo poderá ser cobrado integralmente.
Em geral, este tipo de mensagem é enviada por fornecedores de transporte terrestre (carros e vans) quando um pedido de cancelamento foi solicitado em cima da hora.
Recusa de atendimento (RefuseRequestMessage)
Esta mensagem representa uma recusa de atendimento feita pelo fornecedor. Deverá ser usada toda vez que uma solicitação de atendimento for feita e que não poderá ser atendida pelo fornecedor. Nesta mensagem, informe o código (Drakeild) da necessidade logística e caso queira informar o motivo da recusa, utilize campo Deitails.
Em geral esta mensagem é envida quando uma solicitação está incorreta (possuem datas ou endereços incorretos), caso onde não exista um determinado voo no horário solicitado, etc.