Asociaciones de Dispositivos

Crear Asociaciones de Dispositivos con Vehículos

POST /v2/vehicles/associations/devices

Datos de Envío

{
  "body": {
    "data": [
      {
        "device_id": "abc123def456ghi",
        "vehicle_id": "jkl789mno012pqr",
        "is_main_device": true
      }
    ]
  }
}

Campo	Descripción	Obligatorio
data	Array que contiene objetos representando asociaciones de dispositivos.	sí
device_id	String con el ID del dispositivo, validado utilizando una expresión regular para caracteres alfanuméricos con longitud de 15.	sí
vehicle_id	String con el ID del vehículo, validado utilizando una expresión regular para caracteres alfanuméricos con longitud de 15.	sí
is_main_device	Booleano que indica si el dispositivo es el dispositivo principal para el vehículo.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Uno de 'Device(s) Already Associated With Another Vehicle', 'Vehicle Already Has Main Device' o 'Vehicle And Device Are in Different Enterprises'
404	Not Found	Uno de 'Vehicle Not Found' o 'Device Not Found'

Esta operación no requiere autenticación

Eliminar Asociaciones de Dispositivos con Vehículos

DELETE /v2/vehicles/associations/devices

Datos de Envío

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

Campo	Descripción	Obligatorio
data	Array que contiene objetos representando asociaciones de dispositivos. Cada objeto debe tener un tipo y un id.
type	String que especifica el tipo de asociación, que debe ser igual a 'device_association'.	sí
id	String que especifica el ID de la asociación, que debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Una asociación de vehículo-dispositivo debe ser principal
404	Not Found	Asociación no encontrada

Esta operación no requiere autenticación

Listar Asociaciones de Dispositivos con Vehículos

GET /v2/vehicles/{vehicle_id}/associations/devices

Parámetro	Descripción
attributes	Especifica qué atributos recuperar. Puede incluir valores como 'serial', 'number', 'carrier', 'service_provider' y 'batch'. Si es nulo, recuperará toda la información.
includes	Especifica las entidades relacionadas para incluir en la consulta. Contiene array para 'device' y 'enterprise', cada uno con su propio conjunto de valores posibles, como 'name', 'imei', 'code' para el array 'device', y 'name', 'cnpj' para el array 'enterprise'.
filters	Especifica filtros para varios campos como 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Cada campo de filtro admite condiciones como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica la consulta de búsqueda como mucho 100 caracteres.
limit	Especifica el número máximo de resultados a devolver. Debe ser un número 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.
count	Indica si incluir el total de resultados en la respuesta.
sort	Especifica los criterios de ordenación para los campos 'number' y 'serial'. 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 incorrecta

Esta operación no requiere autenticación

Actualizar Asociaciones de Dispositivos con Vehículos

PATCH /v2/vehicles/{vehicle_id}/associations/devices/{association_id}

Parámetros

{
  "params": {
    "vehicle_id": "abc123DEF456GHI",
    "association_id": "JKL789mno012PQR"
  }
}

Campo	Descripción	Obligatorio
vehicle_id	String com o ID do veículo, composta por 15 caracteres alfanuméricos	sí
association_id	String com o ID da associação, composta por 15 caracteres alfanuméricos	sí

Datos de Envío

{
  "body": {
    "data": {
      "attributes": {
        "is_main_device": true
      }
    }
  }
}

Campo	Descripción	Obligatorio
data	Objeto que contiene los atributos de los datos.	sí
attributes	Objeto que contiene atributos específicos de los datos.
- is_main_device	Booleano que indica si el dispositivo es principal.	no

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Una de las asociaciones de vehículo-dispositivo debe ser principal
404	Not Found	Asociación no encontrada

Esta operación no requiere autenticación

Empresas Associations Users