Pular para o conteúdo principal

Criar um veículo

POSThttps://carchost.fieldcontrol.com.br/vehicles

Cadastra um veículo. Marca e modelo podem ser informados pelo identificador ou pelo nome.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do veículo.

Mínimo de 5 caracteres.

licensePlatestringobrigatório

Placa do veículo.

registerstring

Registro do veículo (ex. Renavam).

typestringobrigatório

Tipo do veículo. Valor fora da lista resulta em erro 500.

Valores aceitos: car, motorcycle, truck, nautical, semi_truck.

originstringobrigatório

Origem do veículo. Valor fora da lista resulta em erro 500.

Valores aceitos: rented, company, employee.

statusstring

Situação do veículo. Padrão available. Valor fora da lista resulta em erro 500.

Valores aceitos: available, unavailable.

colorstring

Cor do veículo. Valor fora da lista resulta em erro 500.

Valores aceitos: yellow, blue, beige, white, bronze, gray, golden, undefined, orange, brown, silver, black, pink, purple, green, red, wine.

yearintegerobrigatório

Ano do veículo. Texto numérico ("2011") também é aceito e convertido.

originalTravelingDistanceintegerobrigatório

Quilometragem do veículo no cadastro.

descriptionstring

Descrição do veículo.

imageUrlstring

URL da foto do veículo.

qrCodestring

Código QR do veículo.

archivedboolean

Arquiva o veículo.

brandobject

Marca, por id ou por name (busca parcial, usa a primeira encontrada). Veja Listar marcas.

Campos de brand
idstring

Identificador da marca.

namestring

Nome da marca.

modelobject

Modelo, por id ou por name (busca parcial, usa o primeiro encontrado). Com name, o id pode ser omitido. Veja Listar modelos.

Campos de model
idstring

Identificador do modelo.

namestring

Nome do modelo.

Respostas

  • 201

    Veículo criado. brand e model voltam como foram enviados ou, quando informados pelo nome, com id e name encontrados.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Corpo inválido (resourceValidationErr) ou marca ou modelo não encontrados pelo nome (reason: not found).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor. Acontece também quando type, origin, status ou color não estão nas listas aceitas.