| type | Enum | Tipo de transporte (padrão=1) 1 - Transporte simples do ponto A ao ponto B 2 - Entrega ao cliente com condutor profissional 3 - Aquisição pelo cliente |
| driverType | Enum | Tipo de condutor (padrão=2) 1 - Condutor particular 2 - Condutor profissional 3 - Camião Somente se 'Transporte Simples' ('type = 1') |
| idAdmin * | Int | Identificador DriiveMe do administrador que solicita o transporte |
| idEntity | Int | Identificador DriiveMe de uma entidade de faturação Ver entidade API |
| idTransportFirstStep | Int | Nº de missão DriiveMe de um transporte anterior para ligar 2 transportes (Entrega + Recolha) |
| idClient | String | ID do cliente do transporte |
| emailDriver | Permitir que um condutor seja obrigado a efetuar o transporte | |
| isProduction | Bool | Se o parâmetro estiver presente com o valor 'true', os transportes serão criados na produção |
| departure | ||
| departure.id *** | Int | ID DriiveMe da morada *** é (departure.id / departure.fullAddress) Ver API |
| departure.fullAddress *** | String | Endereço completo ex: 10 boulevard des batignolles, 75017 Paris *** é (departure.id / departure.fullAddress) |
| departure.type * | Enum | Tipo de estabelecimento do endereço 1 - Agência 2 - Concessionário 3 - Oficina 4 - Loja 5 - Sociedade 6 - Marcação com um particular 7 - Parque de estacionamento * Obrigatório se o endereço completo de partida for inserido |
| departure.name * | String | Nome do estabelecimento / pessoa * Obrigatório se o endereço completo de partida for inserido |
| departure.emails | String | Endereço(s) de e-mail Só se a "partida.fullAddress" for preenchida / (se for mais do que uma devem ser separadas por vírgulas) |
| departure.phones | String | Telefone(s) de morada Só se a "partida.fullAddress" for preenchida / (se for mais do que uma devem ser separadas por vírgulas) |
| destination | ||
| destination.id *** | Int | ID DriiveMe da morada *** é (destination.id / destination.fullAddress) Ver API |
| destination.fullAddress *** | String | Endereço completo ex: 10 boulevard des batignolles, 75017 Paris *** é (destination.id / destination.fullAddress) |
| destination.type * | Enum | Tipo de estabelecimento do endereço 1 - Agência 2 - Concessionário 3 - Oficina 4 - Loja 5 - Sociedade 6 - Marcação com um particular 7 - Parque de estacionamento * Obrigatório se o endereço completo de destino for inserido |
| destination.name * | String | Nome do estabelecimento / pessoa * Obrigatório se o endereço completo de destino for inserido |
| destination.emails | String | Endereço(s) de e-mail Apenas se o destino.fullAddress' for preenchido / (se for mais do que um deve ser separado por vírgulas) |
| destination.phones | String | Telefone(s) de morada Apenas se o destino.fullAddress' for preenchido / (se for mais do que um deve ser separado por vírgulas) |
| vehicle | ||
| vehicle.id ** | Int | ID DriiveMe do veículo ** obrigatório se 'vehicle.category' for nulo Ver API do veículo |
| vehicle.category ** | Enum | Categorie du véhicule à déplacer 1 - Citadino 2 - Carro ligeiro 3 - Desportivo 4 - Monovolume 5 - SUV 6 - Veículo comercial 7 - Pickup 8 - Veículo comercial equipado ** obrigatório se 'vehicle.id' for nulo |
| vehicle.size ** | Int | Tamanho do veículo comercial Somente para viaturas comerciais 'vehicle.category = 6' |
| vehicle.model | String | Marca / modelo do veículo |
| vehicle.nbSeats | Int | Número de lugares no veículo Por defeito 5 lugares e 3 para uma viatura comercial |
| vehicle.registration | String | Registo do veículo |
| vehicle.vin | String | VIN do veículo |
| date | ||
| date.beginAvailability | DateTime | Data de início da disponibilidade na partida |
| date.endAvailability | DateTime | Data final da disponibilidade na partida Calculado automaticamente se não especificado |
| date.beginDelivery | DateTime | Data mínima de entrega na chegada Calculado automaticamente se não especificado |
| date.endDelivery * | DateTime | Data máxima de entrega na chegada |
| date.endOffer | DateTime | Data de validade da oferta Calculado automaticamente se não especificado |
| document | ||
| document.client | String | URL de um documento para anexar ao driver |
| document.grayCard | String | URL do cartão de matrícula do veículo |
| document.pickup | String | URL do comprovante de retirada |
| document.expertise | String | Url do levantamento do veículo |
| document.pvDelivery | String | Url da nota de entrega |
| document.pvPickup | String | Url do aviso de recolha |
| document.cerfa | String | Url do CERFA |
| option | ||
| option.takeRdv | Bool | Opção de nomeação Disponível apenas se a Entrega é ('tipo' = 2 ou 3) |
| option.cleaning | Bool | Opção de limpeza de veículos Disponível apenas se a Entrega é ('tipo' = 2 ou 3) |
| option.demonstration | Bool | Opção de explicação técnica do veículo Disponível apenas se a Entrega é ('tipo' = 2 ou 3) |
| option.w | Bool | Opção de matrícula provisória solicitada Apenas disponível condutor profissional |
| option.electric | Bool | Option véhicule électrique Apenas disponível condutor profissional |
| note | ||
| note.user | String | Nota disponível para visitantes e futuro condutor |
| note.driver | String | Nota disponível apenas para o condutor |
| note.driiveme | String | Nota disponível apenas para DriiveMe |
{"idAdmin": 123,"type": 2, "driverType": 2, "idClient": "myCustomId","departure": {"fullAddress": "3 rue Clairaut, 75017 Paris", "type": 5, "name": "DriiveMe", "phone": "0102030405"},"destination": {"id": 55898},"vehicle": {"category": 2,"registration": "AB-123-YZ"},"date": {"beginAvailability":"2020-01-14 09:00:00","endDelivery":"2020-01-22 16:00:00"},"document": {"pickup": "http://www.mondomaine.com/my-doc.jpg"},"note": {"driver": "Hello World"}}| status * | Enum | Estado da consulta OK - Pedido válido KO - Ocorreu um erro |
| error | String | Mensagem de erro Presente se o status = 'KO' |
| errorCode | Int | Código de erro Presente se o status = 'KO' 500 - Chave API inválida 501 - Estrutura JSON inválida 502 - Parâmetros JSON inválidos 503 - Administrador inválido 504 - Morada inválida 505 - Veículo inválido 506 - Data inválida 510 - Outras pessoas com deficiência |
| id | Int | ID DriiveMe de transporte creado Presente se o status = 'OK' |
| price | Float | Preço de transporte sem IVA Presente se o status = 'OK' |