Associações de Usuários
Criar Associações de Usuários com Veículos
POST /v2/vehicles/associations/users
Dados de Envio
{
"body": {
"data": [
{
"vehicle_id": "ABC1234567890DEF",
"user_id": "GHI9876543210JKL"
},
{
"vehicle_id": "MNO4567890123PQR",
"user_id": "STU2109876543VWX"
}
]
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| data | Objeto | sim |
| vehicle_id | String com o ID do veículo associado ao usuário. Deve ser alfanumérico e ter 15 caracteres. | sim |
| user_id | String com o ID do usuário associado ao veículo. Deve ser alfanumérico e ter 15 caracteres. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
| 400 | Bad Request | Um de 'Bad Request' ou 'Vehicle And User Are in Different Enterprises' |
Esta operação não requer autenticação
Excluir Associações de Usuários com Veículos
DELETE /v2/vehicles/associations/users
Dados de Envio
{
"body": {
"data": [
{
"type": "user_permission",
"id": "ABC1234567890DEF"
},
{
"type": "user_permission",
"id": "GHI9876543210JKL"
}
]
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| data | Objeto | |
| type | String com o tipo de permissão, que deve ser igual a 'user_permission'. | sim |
| id | String com o ID da permissão. Deve ser alfanumérico e ter 15 caracteres. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
| 400 | Bad Request | Requisição inválida |
| 404 | Not Found | Associação Não Encontrada |
Esta operação não requer autenticação
Listar Associações de Usuários com Veículos
GET /v2/vehicles/{vehicle_id}/associations/users
| 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