Saltar al contenido principal

Crear un vehículo

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

Registra un vehículo. La marca y el modelo se pueden informar por el identificador o por el nombre.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre del vehículo.

Mínimo de 5 caracteres.

licensePlatestringobligatorio

Placa del vehículo.

registerstring

Registro del vehículo (p. ej. Renavam).

typestringobligatorio

Tipo del vehículo. Un valor fuera de la lista resulta en error 500.

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

originstringobligatorio

Origen del vehículo. Un valor fuera de la lista resulta en error 500.

Valores aceptados: rented, company, employee.

statusstring

Situación del vehículo. Valor predeterminado available. Un valor fuera de la lista resulta en error 500.

Valores aceptados: available, unavailable.

colorstring

Color del vehículo. Un valor fuera de la lista resulta en error 500.

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

yearintegerobligatorio

Año del vehículo. También se acepta texto numérico ("2011"), que se convierte.

originalTravelingDistanceintegerobligatorio

Kilometraje del vehículo en el registro.

descriptionstring

Descripción del vehículo.

imageUrlstring

URL de la foto del vehículo.

qrCodestring

Código QR del vehículo.

archivedboolean

Archiva el vehículo.

brandobject

Marca, por id o por name (búsqueda parcial, usa la primera encontrada). Consulte Listar marcas.

Campos de brand
idstring

Identificador de la marca.

namestring

Nombre de la marca.

modelobject

Modelo, por id o por name (búsqueda parcial, usa el primero encontrado). Con name, el id se puede omitir. Consulte Listar modelos.

Campos de model
idstring

Identificador del modelo.

namestring

Nombre del modelo.

Respuestas

  • 201

    Vehículo creado. brand y model vuelven como se enviaron o, cuando se informan por el nombre, con el id y el name encontrados.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido (resourceValidationErr) o marca o modelo no encontrados por el nombre (reason: not found).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor. También ocurre cuando type, origin, status o color no están en las listas aceptadas.