Campo | Tipo | Descrição |
---|---|---|
current | Object | Todas as informações recebidas neste tipo de requisição estarão dentro do objeto current |
current._id | String | ID do evento |
current.entity | Objeto | Objeto contendo as informações do evento |
current.entity.type | String | O tipo de entidade realizando o evnto ("job" - rota, "task" ou "service" - serviço) |
current.entity.status | String | Status do evento transmitido[2] |
current.created | String | Data em que o evento foi gravado no banco de dados [1] |
current.date | String | Data em que o evento realizado pelo operador [1] |
current.action | String | Ação executada (start/check_in/start_service/complete) |
current.hash | String | Hash único de identificação desta ação |
current.trackingHash | String | Hash de rastreamento do pedido |
current.tracking | String | URL de monitoramento para o cliente final |
current.status | String | Status da execução deste serviço [2] |
current.values | Object | Campo de metadata [3] |
current.services | Array | Array com os dados dos clientes (dados enviados previamente no delivery group) |
current.services.code | String | Código do cliente |
current.services.name | String | Nome do cliente |
current.services.invoice_number | String | Número da nota fiscal |
current.services.order_number | String | Número do pedido |
current.services.shipment_number | String | Número da remessa |
current.job | Object | Contém os dados de contato do operador e informações da rota |
current.job.id | String | Id do Job |
current.job.due_date | String | Data final de entrega |
current.job.routing | String | Id da rota |
current.job.route | Object | Contém dados da rota |
current.job.route.id | String | Id da rota |
current.job.route.name | String | Nome da rota |
current.job.operador | Object | Dados do operador |
current.job.operador.displayName | String | Nome do operador |
current.job.operador.documentNumber | String | Documento do operador |
current.job.operador.license_plate | String | Placa do veículo do operador |
current.job.operador.phone | Array | Telefone(s) o do operador |
[1]: Não necessariamente a data em que o evento foi criado é a mesma em que o evento foi enviado. O evento pode ser criado pelo operador às 12:06, mas não enviado por falta de sinal. Ao retomar o sinal, às 12:22 por exemplo, o evento será disparado e o horário armazenado no campo created.
Status dos serviços
Assim como os eventos de serviço, os status dos serviços podem ser:
Campo | Descrição |
---|---|
on_transit | Em trânsito para o cliente (Rota iniciada) |
on_route | Em trânsito para o cliente (Próximo atendimento) |
arrived | No local da execução do serviço |
servicing | Serviço em execução |
completed | Serviço finalizado |
Informações que podem ser comunicadas em cada evento
Diversas informações podem ser enviadas junto com os eventos comunicados pelo motorista. Essas informações serão apresentados no objeto {values} e possuem as propriedades: key, value, label e type.
occurrence_code | Código da ocorrência. Dentro deste objeto estarão as informações a respeito da ocorrência que foi registrada pelo operador |
completion_type | Aqui podemos ver se o evento de “completed” foi completo com sucesso ou não. Os valores são success ou failure |
description | Descrição da ocorrência |
comments | Comentários do operador ao finalizar o serviço |
name | Nome do cliente que atendeu o operador |
document | Documento do cliente que atendeu o operador |
file_signature | Arquivo de assinatura digital. O value deste campo é um array que pode receber múltiplas imagens (em base 64) |
file_photo | Arquivo de foto coletada pelo operador. O value deste campo e um array que pode receber múltiplas imagens (em base 64) |
lat | Latitude do momento do disparo do evento |
lng | Longitude do momento do disparo do evento |
device | ID do dispositivo usado pelo operador |