gearsConfigurações Básicas

Permite consultar e atualizar as configurações operacionais básicas da Antena, como potência, tempo de relé, saída Wiegand e entre outros.

1. Obter Configurações Básicas (por Instância)

Descrição:

Retorna os parâmetros básicos da antena acessada via instância, como configurações operacionais básicas da Antena, potência, tempo de relé, saída Wiegand e entre outros.

  • GET /api/v1/vehicleAntennas/instances/{id}/settings/basics

Quando Usar:

  • Para consultar as configurações atuais durante testes ou diagnóstico.

  • Antes de realizar uma atualização de parâmetros.

Obter configurações básicas da antena de tag veicular por Instância conectada

get

Obter configurações básicas da antena de tag veicular por Instância conectada

Autorizações
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 · int32Obrigatório

Id da instância conectada

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
get
/api/v1/vehicleAntennas/instances/{id}/settings/basics

2. Atualizar Configurações Básicas (por Instância)

Descrição:

Envia novos valores para as configurações básicas da antena acessada via instância. Essa atualização altera o comportamento padrão do dispositivo.

  • POST /api/v1/vehicleAntennas/instances/{id}/settings/basics

Quando Usar:

  • Durante a configuração inicial.

  • Para personalizar parâmetros operacionais como tempo de leitura ou modo de operação.

Atualizar configurações básicas da antena de tag veicular por Instância conectada

post

Atualizar configurações básicas da antena de tag veicular por Instância conectada

Autorizações
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 · int32Obrigatório

Id da instância conectada

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
antennaPowerLevelinteger · int32Opcional
languagestring · enumOpcionalValores possíveis:
buzzerLevelinteger · int32Opcional
relayTimeinteger · int32Opcional
passbackTimeinteger · int32Opcional
wiegandOutputstring · enumOpcionalValores possíveis:
wiegandOutputMemorystring · enumOpcionalValores possíveis:
doorSensorinteger · int32Opcional
doorSensorBuzzerbooleanOpcional
enableGroupsbooleanOpcional
sendNotEnrolledTagbooleanOpcional
realTimeLogbooleanOpcional
validationIn24bitsbooleanOpcional
Respostas
chevron-right
201

Quando a atualização ocorrer com sucesso

application/json
post
/api/v1/vehicleAntennas/instances/{id}/settings/basics

3. Obter Configurações Básicas (por ID)

Descrição:

Consulta as configurações básicas da antena já cadastrada no sistema, utilizando seu ID.

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

Quando Usar:

  • Para visualizar os parâmetros definidos em produção.

  • Como parte de auditorias ou manutenção.

Obter configurações básicas da antena de tag veicular

get

Obter configurações básicas da antena de tag veicular

Autorizações
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

Id da antena de tag veicular

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
get
/api/v1/vehicleAntennas/{id}/settings/basics

4. Atualizar Configurações Básicas (por ID)

Descrição:

Atualiza as configurações básicas da antena com base em seu ID cadastrado.

  • POST /api/v1/vehicleAntennas/{id}/settings/basics

Quando Usar:

  • Para alinhar as configurações da antena com padrões operacionais definidos.

  • Em alterações de layout de portaria ou regras de acesso.

Atualizar configurações básicas da antena de tag veicular

post

Atualizar configurações básicas da antena de tag veicular

Autorizações
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

Id da antena de tag veicular

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
antennaPowerLevelinteger · int32Opcional
languagestring · enumOpcionalValores possíveis:
buzzerLevelinteger · int32Opcional
relayTimeinteger · int32Opcional
passbackTimeinteger · int32Opcional
wiegandOutputstring · enumOpcionalValores possíveis:
wiegandOutputMemorystring · enumOpcionalValores possíveis:
doorSensorinteger · int32Opcional
doorSensorBuzzerbooleanOpcional
enableGroupsbooleanOpcional
sendNotEnrolledTagbooleanOpcional
realTimeLogbooleanOpcional
validationIn24bitsbooleanOpcional
Respostas
chevron-right
201

Quando a atualização ocorrer com sucesso

application/json
post
/api/v1/vehicleAntennas/{id}/settings/basics

Atualizado