CRUD e Gerenciamento

Esta categoria abrange os endpoints responsáveis pelo ciclo completo de gerenciamento das antenas de tag veicular cadastradas no sistema. Permite criar, consultar, atualizar e desabilitar antenas. Esses recursos são fundamentais para manter o cadastro das antenas sempre atualizado, refletindo a infraestrutura real instalada em campo.

1. Obter antenas por filtro

Descrição:

Retorna uma lista de antenas cadastradas, com suporte a filtros de busca (como status, nome, IP, entre outros).

• GET /api/v1/vehicleAntennas

Quando Usar:

• Utilize para consultar rapidamente as antenas ativas, inativas ou com critérios específicos (ex: localização, cliente). Essencial para telas de listagem, diagnósticos ou relatórios.

Obter antenas de tag veicular por filtro

get

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta

IpAddressstringOpcional

DescriptionstringOpcional

EquipmentstringOpcional

ModelstringOpcional

LocalstringOpcional

StartDatestring · date-timeOpcional

EndDatestring · date-timeOpcional

PageSizeinteger · int32ObrigatórioDefault: 10

PageNumberinteger · int32ObrigatórioDefault: 1

EnabledbooleanOpcionalDefault: true

SortOrderstringOpcionalDefault: asc

SortFieldstringObrigatórioDefault: id

ValuestringOpcional

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

get

/api/v1/vehicleAntennas

HTTPcURLJavaScriptPython

GET /api/v1/vehicleAntennas?PageSize=10&PageNumber=1&SortField=id HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "data": [
      {
        "id": 1,
        "isEnabled": true,
        "ipAddress": "text",
        "port": 1,
        "passcode": "text",
        "description": "text",
        "createdAt": "2026-01-16T14:20:10.752Z",
        "instance": 1,
        "model": "text",
        "local": "text",
        "equipment": "text"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 1,
    "pages": 1
  }
}

---

2. Criar nova antena

Descrição:

Cadastra uma nova antena no sistema, incluindo suas configurações e dados de rede.

• POST /api/v1/vehicleAntennas

Quando Usar:

• Use durante o processo de instalação de uma nova antena, onde ela precisa ser registrada no sistema antes de iniciar sua operação.

Cria nova antena de tag veicular

post

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

ipAddressstring | nuloOpcional

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/vehicleAntennas

HTTPcURLJavaScriptPython

POST /api/v1/vehicleAntennas HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-16T14:20:10.752Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

3. Obter antena (por ID)

Descrição:

Busca os dados detalhados de uma antena específica, com base no seu ID.

• GET /api/v1/vehicleAntennas/{id}

Quando Usar:

• Utilize quando for necessário visualizar ou validar as configurações de uma antena já cadastrada, como em telas de edição ou auditoria.

Obter antena de tag veicular pelo Id

get

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

get

/api/v1/vehicleAntennas/{id}

HTTPcURLJavaScriptPython

GET /api/v1/vehicleAntennas/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-16T14:20:10.752Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

4. Atualizar Antena (por ID)

Descrição:

Atualiza os dados de uma antena previamente cadastrada. Permite modificar configurações como IP, nome ou parâmetros operacionais.

• PUT /api/v1/vehicleAntennas/{id}: Altera as informações da antena identificada pelo id.

Quando Usar:

• Após mudanças de rede (IP/porta).

• Para renomear a antena ou alterar parâmetros.

• Para corrigir informações registradas erroneamente.

Atualiza antena de tag veicular

put

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Corpo

application/jsontext/jsonapplication/*+json

idinteger · int64Opcional

ipAddressstring | nuloOpcional

portinteger · int32Opcional

descriptionstring | nuloOpcional

modelstring | nuloOpcional

localstring | nuloOpcional

equipmentstring | nuloOpcional

Respostas

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

put

/api/v1/vehicleAntennas/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/vehicleAntennas/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": 1,
  "ipAddress": "text",
  "port": 1,
  "description": "text",
  "model": "text",
  "local": "text",
  "equipment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "failure": true,
  "data": {
    "id": 1,
    "isEnabled": true,
    "ipAddress": "text",
    "port": 1,
    "passcode": "text",
    "description": "text",
    "createdAt": "2026-01-16T14:20:10.752Z",
    "instance": 1,
    "model": "text",
    "local": "text",
    "equipment": "text"
  }
}

---

5. Desabilitar antena (por ID)

Descrição:

Desativa ou remove do sistema uma antena previamente cadastrada. Esta ação é recomendada quando o dispositivo não está mais em uso ou foi substituído.

• DELETE /api/v1/vehicleAntennas/{id}: Remove a antena identificada pelo id da base do sistema.

Quando Usar:

• Utilize quando uma antena for desinstalada ou substituída, mas deseja-se manter o histórico no sistema sem excluí-la fisicamente do banco de dados.

Desabilita antena de tag veicular

delete

Autorizações

BearerApiKey

AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Enter 'Bearer'[space] and then your token in the text input below.

Example: "Bearer 12345abcdef"

Parâmetros de rota

idinteger · int64Obrigatório

Parâmetros de consulta

cultureNamestringOpcional

Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)

Default: en-US

Respostas

200

OK

application/json

400

Bad Request

application/json

delete

/api/v1/vehicleAntennas/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/vehicleAntennas/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "failure": true,
  "data": true
}