API
Documentação

Lista de transporte

Permite-lhe listar os seus transportes referenciados na DriiveMe

    Request    

Url (POST)

https://www.driiveme.pt/api/transport/list?key=[YOUR-API-KEY]

Estrutura corporal (JSON)

page Int Especifique uma página (se os resultados são > 100)
idTransport Array[Int] Filtrar por um ou mais identificadores de transporte
status Array[Int] Filtrar por um ou mais estados
1 - Online
2 - Em pausa
3 - Cancelado
4 - Reservado
5 - Partiu
6 - Chegou
7 - Transferido
8 - Expirado
9 - Não realizado
11 - Marcação de ponto de encontro
12 - À espera de especialização
-8 - Qualificação
idAdmin Int Filtrar por ID do administrador que solicitou o transporte
registration String Filtrar por matrícula
startDate Date Filtrar a lista por data mínima de pedido
stopDate Date Filtrar a lista por data máxima de pedido

Exemplo JSON

{"page": 2, "idTransport": [1234], "status": [1,2],"startDate": "2020-06-01", "stopDate": "2020-06-30"}

    Response    

nbTransports Int Número de transportes nesta página
totalTransports Int Número total de transportes
currentPage Int Número da página atual
totalPages Int Número total de páginas
transports Array Lista de transporte
transports
transports.id Int ID DriiveMe do transporte
transports.clientId Sring ID do cliente do transporte
transports.status Int Estado do transporte
1 - Online
2 - Em pausa
3 - Cancelado
4 - Reservado
5 - Partiu
6 - Chegou
7 - Transferido
8 - Expirado
9 - Não realizado
11 - Marcação de ponto de encontro
12 - À espera de especialização
-8 - Qualificação
transports.distance Int Distância de viagem (km)
transports.duration Int Tiempo de viaje (minutos)
transports.price Float Custo do transporte
transports.creationDate DateTime Data do pedido de transporte
transports.beginAvailabiltyDate DateTime Data de início da disponibilidade na partida
transports.endAvailabiltyDate DateTime Data final da disponibilidade na partida
transports.beginDeliveryDate DateTime Data mínima de entrega na chegada
transports.endDeliveryDate DateTime Data máxima de entrega na chegada
transports.admin
transports.admin.id Int Identificador do administrador que solicitou o transporte
transports.admin.name String Nome do administrador
transports.admin.email String Email do administrador
transports.departure
transports.departure.id Int Identificador DriiveMe da morada de partida
transports.departure.idClient String ID do cliente do endereço
transports.departure.name String Nome da morada
transports.departure.address String Morada
transports.departure.postalCode String Código postal da morada
transports.departure.city String Cidade da morada
transports.departure.country String País da morada
transports.departure.latitude Float Latitude da morada
transports.departure.longitude Float Longitude da morada
transports.destination
transports.destination.id Int Identificador DriiveMe da morada de chegada
transports.destination.idClient String ID do cliente do endereço
transports.destination.name String Nome da morada
transports.destination.address String Morada
transports.destination.postalCode String Código postal da morada
transports.destination.city String Cidade da morada
transports.destination.country String País da morada
transports.destination.latitude Float Latitude da morada
transports.destination.longitude Float Longitude da morada
transports.vehicle
transports.vehicle.id Int ID DriiveMe do veículo
transports.vehicle.category String Categoria do veículo
transports.vehicle.model String Modelo do veículo
transports.vehicle.registration String Registo do veículo
transports.vehicle.vin String Número de chassis do veículo
transports.reservation Presente só se houver uma reserva ativa no transporte
transports.reservation.id Int Identificador da reserva
transports.reservation.creationDate DateTime Data de reserva
transports.reservation.pickupDate DateTime Data estimada de levantamento do veículo
transports.reservation.deliveryDate DateTime Data estimada de entrega do veículo
transports.reservation.realPickupDate DateTime Data da recolha efectiva do veículo
transports.reservation.realDeliveryDate DateTime Data da entrega efectiva do veículo
transports.reservation.driver
transports.reservation.driver.id Int ID do condutor
transports.reservation.driver.name String Nome do condutor
transports.reservation.driver.email String Email do condutor
transports.reservation.driver.phone String Telefone do condutor