Actualizar un vehículo
https://carchost.fieldcontrol.com.br/vehicles/{id}Actualiza un vehículo. El cuerpo sigue las mismas reglas de la creación. La respuesta de éxito usa el estado 201.
Requiere los headers
X-Api-Key,User-AgentyContent-Type: application/json. Límite: 1 solicitud por segundo (más información).
Solicitud
Parámetros de ruta
idstringobligatorioIdentificador del vehículo.
Ejemplo: ZmEzZWIyYmQtNTIwYS00Yzc5LWIwZGMtZGQ4YWVmMWIwZjM3OjIyOTE1.
Headers
User-AgentstringobligatorioIdentificación de su aplicación.
Ejemplo: MinhaIntegracao/1.0.
Cuerpo de la solicitud
JSON, enviado con el header Content-Type: application/json.
namestringobligatorioNombre del vehículo.
Mínimo de 5 caracteres.
licensePlatestringobligatorioPlaca del vehículo.
registerstringRegistro del vehículo (p. ej. Renavam).
typestringobligatorioTipo del vehículo. Un valor fuera de la lista resulta en error 500.
Valores aceptados: car, motorcycle, truck, nautical, semi_truck.
originstringobligatorioOrigen del vehículo. Un valor fuera de la lista resulta en error 500.
Valores aceptados: rented, company, employee.
statusstringSituación del vehículo. Valor predeterminado available. Un valor fuera de la lista resulta en error 500.
Valores aceptados: available, unavailable.
colorstringColor 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.
yearintegerobligatorioAño del vehículo. También se acepta texto numérico ("2011"), que se convierte.
originalTravelingDistanceintegerobligatorioKilometraje del vehículo en el registro.
descriptionstringDescripción del vehículo.
imageUrlstringURL de la foto del vehículo.
qrCodestringCódigo QR del vehículo.
archivedbooleanArchiva el vehículo.
brandobjectMarca, por id o por name (búsqueda parcial, usa la primera encontrada). Consulte Listar marcas.
Campos de brand
idstringIdentificador de la marca.
namestringNombre de la marca.
modelobjectModelo, 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
idstringIdentificador del modelo.
namestringNombre del modelo.
Respuestas
- 201
Vehículo actualizado.
- 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
Identificador inválido o de otra cuenta en la URL (uriValidationErr), vehículo inexistente (
resourceValidationErrconmessage: vehicle not found; no hay 404), cuerpo inválido o marca o modelo no encontrados.resourceValidationErr→ - 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,statusocolorno están en las listas aceptadas.