Associações de Dispositivos

Criar Associações de Dispositivos com Veículos

POST /v2/vehicles/associations/devices

Dados de Envio

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

Campo	Descrição	Obrigatório
data	Array contendo objetos representando associações de dispositivos.	sim
device_id	String com o ID do dispositivo, validado usando uma expressão regular para caracteres alfanuméricos com comprimento 15.	sim
vehicle_id	String com o ID do veículo, validado usando uma expressão regular para caracteres alfanuméricos com comprimento 15.	sim
is_main_device	Booleano indicando se o dispositivo é o dispositivo principal para o veículo.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Um de 'Device(s) Already Associated With Another Vehicle', 'Vehicle Already Has Main Device' ou 'Vehicle And Device Are in Different Enterprises'
404	Not Found	Um de 'Vehicle Not Found' ou 'Device Not Found'

Esta operação não requer autenticação

Excluir Associações de Dispositivos com Veículos

DELETE /v2/vehicles/associations/devices

Dados de Envio

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

Campo	Descrição	Obrigatório
data	Array contendo objetos representando associações de dispositivos. Cada objeto deve ter um tipo e um id.
type	String que especifica o tipo de associação, que deve ser igual a 'device_association'.	sim
id	String especificando o ID da associação, deve consistir em 15 caracteres alfanuméricos.	sim

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Uma associação de veículo-dispositivo deve ser principal
404	Not Found	Associação não encontrada

Esta operação não requer autenticação

Listar Associações de Dispositivos com Veículos

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

Parâmetro	Descrição
attributes	Especifica quais atributos recuperar. Pode incluir valores como 'serial', 'number', 'carrier', 'service_provider' e 'batch'. Se nulo, recupera todas as informações.
includes	Especifica as entidades relacionadas a serem incluídas na consulta. Contém arrays para 'device' e 'enterprise', cada um com seu próprio conjunto de valores possíveis, como 'name', 'imei', 'code' para o array 'device', e 'name', 'cnpj' para o array 'enterprise'.
filters	Especifica filtros para vários 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 suporta condições como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica a consulta de pesquisa com um comprimento máximo de 100 caracteres.
limit	Especifica o número máximo de resultados a retornar. Deve ser um número entre 1 e 100.
page	Especifica o número da página para resultados paginados. Deve ser um número maior ou igual a 0.
count	Indica se incluir o total de resultados na resposta.
sort	Especifica os critérios de ordenação para os campos 'number' e 'serial'. Os valores podem ser -1 (ordem decrescente) ou 1 (ordem crescente).

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Requisição inválida

Esta operação não requer autenticação

Atualizar Associações de Dispositivos com Veículos

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

Parâmteros

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

Campo	Descrição	Obrigatório
vehicle_id	String com o ID do veículo, composta por 15 caracteres alfanuméricos	sim
association_id	String com o ID da associação, composta por 15 caracteres alfanuméricos	sim

Dados de Envio

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

Campo	Descrição	Obrigatório
data	Objeto contendo os atributos dos dados.	sim
attributes	Objeto contendo atributos específicos dos dados.
- is_main_device	Booleano indicando se o dispositivo é o principal.	não

Respostas

Status	Significado	Descrição
200	OK	Resposta padrão
400	Bad Request	Uma das Associações de Veículo-Dispositivo Deve Ser Principal
404	Not Found	Associação Não Encontrada

Esta operação não requer autenticação

Empresas Associations Users