Vehículos

Listar Vehículos

GET /v2/vehicles

Campo	Descripción
attributes	Array de atributos a recuperar. Puede contener valores como 'batch', 'plate', 'code', 'vin', 'type', 'brand', 'model', 'year', 'description', 'registration_number', 'color', 'user_names', 'deactivated_at'. Si es nulo, se recuperan todas las informaciones.
includes	Objeto que especifica qué entidades relacionadas incluir en la consulta. Contiene matrices para 'devices', 'enterprises', 'users' y 'document'.
filters	Objeto que especifica filtros para diferentes campos como 'asset_vehicles.plate', 'asset_vehicles.vin', 'asset_vehicles.type', etc. Cada campo de filtro puede tener condiciones como 'eq' (igual), 'neq' (no igual), 'ilk' (comienza con), 'ew' (termina con), 'sw' (contiene).
search	String que especifica la consulta de búsqueda como mucho 100 caracteres.
limit	Especifica el número máximo de resultados a devolver. El valor debe ser un número, limitado entre 1 y 100.
page	Especifica el número de página para resultados paginados. Debe ser un número mayor o igual a 0, indicando la página deseada.
count	Booleano que indica si se debe incluir el total de resultados en la respuesta.
sort	Objeto que especifica criterios de clasificación, con opciones para los campos 'batch', 'brand', 'label', 'trim' y 'vin'. Los valores pueden ser -1 (orden descendente) o 1 (orden ascendente).

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud Inválida

Esta operación no requiere autenticación

Crear Vehículos

POST /v2/vehicles

Datos de Envío

{
  "body": {
    "data": [
      {
        "attributes": {
          "plate": "ABC1234",
          "vin": "12345678901234567",
          "type": "sedan",
          "code": "12345",
          "brand": "Toyota",
          "model": "Corolla",
          "year": "2020",
          "description": "Vehicle description",
          "color": "red",
          "batch": "67890",
          "registration_number": "R1234567"
        },
        "relationships": {
          "enterprise": {
            "type": "enterprise",
            "id": "abc123def456ghi"
          }
        }
      }
    ]
  }
}

Campo	Descripción	Obrigatorio
data	Array de objetos que representan los datos del vehículo.
attributes	Objeto que contiene los atributos del vehículo. Al menos uno de los campos 'plate' o 'vin' debe estar presente.	sí
- plate	String con la placa del vehículo, como mucho 16 caracteres.
- vin	String con el Número de Identificación del Vehículo (VIN), como mucho 20 caracteres.
- type	String con el tipo de vehículo, como mucho 20 caracteres. Debe ser uno de los tipos de vehículos predefinidos.	sí
- code	String con el código del vehículo, como mucho 16 caracteres.	no
- brand	String con la marca del vehículo, como mucho 20 caracteres.	no
- model	String con el modelo del vehículo, como mucho 20 caracteres.	no
- year	String con el año del vehículo, como mucho 10 caracteres.	no
- description	String con la descripción del vehículo, como mucho 20 caracteres.	no
- color	String con el color del vehículo. Debe ser uno de los colores predefinidos, como mucho 7 caracteres.	no
- batch	String con la información del lote del vehículo, como mucho 20 caracteres.	no
- registration_number	String con el número de registro del vehículo, como mucho 20 caracteres.	no
relationships	Objeto que contiene datos de relación.	no
- enterprise	Objeto que representa la relación con una empresa.	no
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request', 'Resource Already Exists', 'Vehicle`s Enterprise is Missing' o 'Vehicle`s Type is Missing'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Eliminar Vehículos

DELETE /v2/vehicles

Datos de Envío

{
  "body": {
    "data": [
      {
        "type": "vehicles",
        "id": "abc123def456ghi"
      }
    ]
  }
}

Campo	Descripción	Requerido
data	Array de objetos que representan datos de vehículos.	true
type	Tipo de objeto de datos. Debe ser 'vehicles'.	true
id	ID del vehículo. Debe consistir en 15 caracteres alfanuméricos.	true

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar

Esta operación no requiere autenticación

Mostrar Vehículo

GET /v2/vehicles/{id}

Parámetro	Descripción
attributes	Un array de atributos para recuperar. Puede incluir valores como 'batch', 'plate', 'code', 'vin', 'type', 'brand', 'model', 'year', 'description', 'registration_number', 'color', 'user_names', 'deactivated_at'. Si es nulo, se recuperan toda la información.
includes	Especifica las entidades relacionadas para incluir en la consulta. Contiene matrices para 'device', 'enterprise', 'user' y 'document'. Cada array puede incluir valores como 'name', 'imei', 'code', 'cnpj', 'username', 'cpf', 'email', 'phone1', 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.
- device	Array de atributos del dispositivo para incluir. Puede contener valores como 'name', 'imei', 'code'.
- enterprise	Array de atributos de la empresa para incluir. Puede contener valores como 'name', 'cnpj'.
- users	Array de atributos del usuario para incluir. Puede contener valores como 'name', 'username', 'cpf', 'email', 'phone1'.
- document	Array de atributos del documento para incluir. Puede contener valores como 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud inválida
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar Vehículo

PATCH /v2/vehicles/{id}

Datos de Envío

{
  "body": {
    "data": {
      "attributes": {
        "plate": "ABC1234",
        "vin": "1HGCM82633A005352",
        "type": "sedan",
        "code": "ABC123",
        "brand": "Honda",
        "model": "Civic",
        "year": "2022",
        "description": "Red sedan",
        "color": "red",
        "batch": "202201",
        "registration_number": "DEF456"
      },
      "relationships": {
        "enterprise": {
          "type": "enterprise",
          "id": "GHI789012345678"
        }
      }
    }
  }
}

Campo	Descripción	Obrigatorio
data	Array de objetos que representan los datos del vehículo.
attributes	Objeto que contiene los atributos del vehículo. Al menos uno de los campos 'plate' o 'vin' debe estar presente.	sí
- plate	String con la placa del vehículo, como mucho 16 caracteres.
- vin	String con el Número de Identificación del Vehículo (VIN), como mucho 20 caracteres.
- type	String con el tipo de vehículo, como mucho 20 caracteres. Debe ser uno de los tipos de vehículos predefinidos.	sí
- code	String con el código del vehículo, como mucho 16 caracteres.	no
- brand	String con la marca del vehículo, como mucho 20 caracteres.	no
- model	String con el modelo del vehículo, como mucho 20 caracteres.	no
- year	String con el año del vehículo, como mucho 10 caracteres.	no
- description	String con la descripción del vehículo, como mucho 20 caracteres.	no
- color	String con el color del vehículo. Debe ser uno de los colores predefinidos, como mucho 7 caracteres.	no
- batch	String con la información del lote del vehículo, como mucho 20 caracteres.	no
- registration_number	String con el número de registro del vehículo, como mucho 20 caracteres.	no
relationships	Objeto que contiene datos de relación.	no
- enterprise	Objeto que representa la relación con una empresa.	no
-- type	String con el tipo de relación, debe ser 'enterprise'.	sí
-- id	String con el ID de la empresa, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Bad Request', 'Not Found Enterprise Ownership', 'Vehicle`s Type is Missing', 'Vehicle and User are In Different Enterprises', 'Vehicle`s new Enterprise Does Not Belong to Same Owner' o 'Vehicle Cannot be Changed to Another Asset Type'
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar {situation} Vehículos

PATCH /v2/vehicles/{id}/status/{situation}

Parámetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situation": "activation"
  }
}

Campo	Descripción	Obligatorio
id	String que contiene el ID, debe seguir el patrón alfanumérico y tener una longitud de 15 caracteres.	sí
situation	String que indica la situación, debe ser 'activation' o 'deactivation'.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud incorrecta

Esta operación no requiere autenticación

Trajectories