Al llamado de este recurso se deben obtener datos relacionados al vehículo de acuerdo a los valores proporcionados a través de los parámetros de la llamada.
Obtiene el detalle de un vehículo en específico
GET
/vehicles/{vin}
Parámetros
organizationId
REQUERIDO
(header)
Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.
16
vin
REQUERIDO
(path)
Número de identificación vehicular.
93482
Cuerpo de solicitud
Sin datos
Respuestas
Code 200
Solicitud completada de forma satisfactoria.
- Ejemplo
- Esquema
{
"success": true,
"message": null,
"data": {
"vehicleId": "93482",
"vin": "38JD930KPC0278DJ90E",
"brand": "Mazda",
"model": "Mazda 3",
"year": "2020",
"licensePlate": "UVV3381",
"kilometers": "20000",
"idClient": "290839",
"firstName": "Diana",
"lastName": "Carranza",
"mainPhone": "5567231398",
"mobile": "5519345472",
"email": "dca_mo92@hotmail.com"
}
}
{
}
| success* | boolean Valor que indica que el llamado al recurso fue exitoso. / Field that tells if a request was successful. | |||||||||||||||||||||||||||||
| message* | string nullable: true Proporciona una pequeña descripción cuando ocurre un error al llamado del recurso, por lo regular el valor de este parametro es nulo si no ocurre algún error. / Error message description, can be null if it was a successful request. | |||||||||||||||||||||||||||||
| data* | {
| |||||||||||||||||||||||||||||
Code 400
Error de solicitud incorrecta, se recomienda proporcionar más detalle a través del atributo “mensaje”, indicando si faltan parámetros para realizar la búsqueda.
- Ejemplo
- Esquema
{
"success": false,
"message": "El servidor no puede entender la solicitud debido a un error de sintaxis del lado del cliente, faltan los parámetros: xxxxx, yyyyy, zzzzz. / There is a client side syntax error. The following paramters are missing: xxxxx, yyyyy, zzzzz.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |
Code 404
No se encontró una coincidencia con los parámetros de búsqueda.
- Ejemplo
- Esquema
{
"success": false,
"message": "No se encontraron datos que cumplan con los criterios proporcionados a través de los parámetros. / There was no match for the resource you're looking for.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |
Code 500
Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.
- Ejemplo
- Esquema
{
"success": false,
"message": "El servidor se ha encontrado con una situación que no sabe cómo manejar, intentelo más tarde. / The server can't handle your request at the moment, please try again later.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |
