Grupos

A funcionalidade de grupos permite organizar e controlar o acesso de tags veiculares com base em critérios personalizados. Cada grupo pode representar diferentes níveis de permissão, horários de liberação ou regras específicas de operação. Essa seção permite consultar, configurar e detalhar os grupos de uma antena.

1. Obter Todos os Grupos (por Instância)

Descrição:

Retorna todos os grupos configurados na antena acessada por meio de uma instância ativa (descoberta e ainda não cadastrada). Ideal para diagnóstico e replicação de configurações.

GET /api/v1/vehicleAntennas/instances/{id}/groups

Quando Usar:

Durante o processo de descoberta e análise de uma antena.
Para importar as configurações existentes em um novo cadastro.

Obter tabela de todos os grupos da antena de tag veicular por Instância conectada

get

Obter tabela de todos os grupos 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

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/instances/{id}/groups

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

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

2. Atualizar Grupos (por Instância)

Descrição:

Envia a lista de grupos que será aplicada à antena acessada pela instância. A operação sobrescreve a configuração anterior, sincronizando os dados com o sistema.

POST /api/v1/vehicleAntennas/instances/{id}/groups

Quando Usar:

Ao aplicar uma configuração padrão em antenas recém-descobertas.
Para garantir a padronização dos grupos antes do cadastro definitivo.

Atualizar uma lista de grupos da antena de tag veicular por Instância conectada

post

Atualizar uma lista de grupos da antena de tag veicular por Instância conectada.

Os nomes dos dias da semana devem seguir a lista: [Mon, Tue, Wed, Thu, Fri, Sat, Sun] e [Hol] (para Holiday/Feriado), podendo ser adicionados em qualquer ordem.

Não é necessário adicionar todos os dias, somente aqueles que se deseja ativar no grupo. Os dias da semana não fornecidos serão considerados com valor 'false'.

São permitidos até 15 grupos numerados de 1 a 15.

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

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/instances/{id}/groups

POST /api/v1/vehicleAntennas/instances/{id}/groups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "groups": [
    {
      "groupNumber": 1,
      "groupLabel": "text",
      "daysOfWeekTable": [
        {
          "dayOfWeek": "text",
          "isSelected": true
        }
      ],
      "inTime": "14:20:10",
      "outTime": "14:20:10"
    }
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

3. Obter Grupo Específico (por Instância)

Descrição:

Retorna os dados de um grupo específico da antena, acessada via instância. Requer o número do grupo como parâmetro.

GET /api/v1/vehicleAntennas/instances/{id}/groups/{groupNumber}

Quando Usar:

Para inspecionar um grupo específico em uma antena em fase de configuração.
Para comparar grupos entre antenas.

Obter um Grupo da antena de tag veicular por Instância conectada

get

Obter um Grupos 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

groupNumberinteger · int32Obrigató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

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/instances/{id}/groups/{groupNumber}

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

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

4. Atualizar grupo específico (por Instância)

Descrição:

Atualiza as configurações de um grupo específico por meio de uma instância ativa da antena.

POST /api/v1/vehicleAntennas/instances/{id}/groups/{groupNumber}

Quando Usar:

Utilize em cenários com conexão em tempo real, como ajustes feitos durante instalação ou testes em campo, onde a antena está acessível via instância ativa.

Atualizar um grupo da antena de tag veicular por Instância conectada

post

Atualizar um grupo da antena de tag veicular por Instância conectada.

Os nomes dos dias da semana devem seguir a lista: [Mon, Tue, Wed, Thu, Fri, Sat, Sun] e [Hol] (para Holiday/Feriado), podendo ser adicionados em qualquer ordem.

Não é necessário adicionar todos os dias, somente aqueles que se deseja ativar no grupo. Os dias da semana não fornecidos serão considerados com valor 'false'.

O 'groupNumber' pode ser numerado de 1 a 15.

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

groupNumberinteger · int32Obrigatório

Número do Grupo a atualizar

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

groupLabelstring | nuloOpcional

inTimestring · timeOpcional

outTimestring · timeOpcional

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/instances/{id}/groups/{groupNumber}

POST /api/v1/vehicleAntennas/instances/{id}/groups/{groupNumber} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "groupLabel": "text",
  "daysOfWeekTable": [
    {
      "dayOfWeek": "text",
      "isSelected": true
    }
  ],
  "inTime": "14:20:10",
  "outTime": "14:20:10"
}

{
  "success": true,
  "failure": true,
  "data": {
    "groupNumber": 1,
    "groupLabel": "text",
    "daysOfWeekTable": [
      {
        "dayOfWeek": "text",
        "isSelected": true
      }
    ],
    "inTime": "14:20:10",
    "outTime": "14:20:10"
  }
}

5. Obter Todos os Grupos (por ID)

Descrição:

Retorna a lista completa de grupos configurados em uma antena já cadastrada no sistema, identificada pelo seu ID.

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

Quando Usar:

Para consultar grupos ativos em produção.
Em auditorias ou ajustes operacionais.

Obter tabela de todos os grupos da antena de tag veicular

get

Obter tabela de todos os grupos 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

200

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/{id}/groups

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

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

6. Atualizar Grupos (por ID)

Descrição:

Atualiza a configuração atual de grupos da antena com ID definido por uma nova lista de grupos. A atualização é total e imediata.

POST /api/v1/vehicleAntennas/{id}/groups

Quando Usar:

Para atualizar permissões ou políticas de acesso.
Quando há alteração de regras organizacionais.

Atualizar uma lista de grupos da antena de tag veicular

post

Atualizar uma lista de grupos da antena de tag veicular.

Os nomes dos dias da semana devem seguir a lista: [Mon, Tue, Wed, Thu, Fri, Sat, Sun] e [Hol] (para Holiday/Feriado), podendo ser adicionados em qualquer ordem.

Não é necessário adicionar todos os dias, somente aqueles que se deseja ativar no grupo. Os dias da semana não fornecidos serão considerados com valor 'false'.

São permitidos até 15 grupos numerados de 1 a 15.

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

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/{id}/groups

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

{
  "groups": [
    {
      "groupNumber": 1,
      "groupLabel": "text",
      "daysOfWeekTable": [
        {
          "dayOfWeek": "text",
          "isSelected": true
        }
      ],
      "inTime": "14:20:10",
      "outTime": "14:20:10"
    }
  ]
}

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

7. Obter Grupo Específico (por ID)

Descrição:

Retorna os dados de um grupo específico cadastrado em uma antena identificada por ID. O grupo é referenciado pelo seu número

GET /api/v1/vehicleAntennas/{id}/groups/{groupNumber}

Quando Usar:

Para verificar detalhes de um grupo ativo.
Durante o suporte técnico ou reconfigurações pontuais.

Obter um Grupo da antena de tag veicular

get

Obter um Grupo 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

groupNumberinteger · int32Obrigató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

Quando a obtenção das informações ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

get

/api/v1/vehicleAntennas/{id}/groups/{groupNumber}

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

{
  "success": true,
  "failure": true,
  "data": {
    "groups": [
      {
        "groupNumber": 1,
        "groupLabel": "text",
        "daysOfWeekTable": [
          {
            "dayOfWeek": "text",
            "isSelected": true
          }
        ],
        "inTime": "14:20:10",
        "outTime": "14:20:10"
      }
    ],
    "total": 1
  }
}

8. Atualizar grupo específico (por ID)

Descrição:

Atualiza as configurações de um grupo específico da antena, identificado pelo número do grupo e pelo ID da antena.

POST /api/v1/vehicleAntennas/{id}/groups/{groupNumber}

Quando Usar:

Use em operações administrativas onde se deseja alterar ou aplicar novas regras a um grupo já configurado na antena. Por exemplo, mudar parâmetros de leitura, aplicar novos filtros ou atualizar zonas de leitura.

Atualizar um grupo da antena de tag veicular

post

Atualizar um grupo da antena de tag veicular.

Os nomes dos dias da semana devem seguir a lista: [Mon, Tue, Wed, Thu, Fri, Sat, Sun] e [Hol] (para Holiday/Feriado), podendo ser adicionados em qualquer ordem.

Não é necessário adicionar todos os dias, somente aqueles que se deseja ativar no grupo. Os dias da semana não fornecidos serão considerados com valor 'false'.

O 'groupNumber' pode ser numerado de 1 a 15.

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

groupNumberinteger · int32Obrigatório

Número do Grupo a atualizar

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

groupLabelstring | nuloOpcional

inTimestring · timeOpcional

outTimestring · timeOpcional

Respostas

201

Quando a atualização ocorrer com sucesso

application/json

400

Quando ocorrer erro

application/json

post

/api/v1/vehicleAntennas/{id}/groups/{groupNumber}

POST /api/v1/vehicleAntennas/{id}/groups/{groupNumber} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "groupLabel": "text",
  "daysOfWeekTable": [
    {
      "dayOfWeek": "text",
      "isSelected": true
    }
  ],
  "inTime": "14:20:10",
  "outTime": "14:20:10"
}

{
  "success": true,
  "failure": true,
  "data": {
    "groupNumber": 1,
    "groupLabel": "text",
    "daysOfWeekTable": [
      {
        "dayOfWeek": "text",
        "isSelected": true
      }
    ],
    "inTime": "14:20:10",
    "outTime": "14:20:10"
  }
}

AnteriorFeriados PróximoUsuários

Atualizado há 7 meses

hashtag1. Obter Todos os Grupos (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter tabela de todos os grupos da antena de tag veicular por Instância conectada

hashtag2. Atualizar Grupos (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar uma lista de grupos da antena de tag veicular por Instância conectada

hashtag3. Obter Grupo Específico (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter um Grupo da antena de tag veicular por Instância conectada

hashtag4. Atualizar grupo específico (por Instância)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar um grupo da antena de tag veicular por Instância conectada

hashtag5. Obter Todos os Grupos (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter tabela de todos os grupos da antena de tag veicular

hashtag6. Atualizar Grupos (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar uma lista de grupos da antena de tag veicular

hashtag7. Obter Grupo Específico (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagObter um Grupo da antena de tag veicular

hashtag8. Atualizar grupo específico (por ID)

hashtagDescrição:

hashtagQuando Usar:

hashtagAtualizar um grupo da antena de tag veicular

1. Obter Todos os Grupos (por Instância)

Descrição:

Quando Usar:

Obter tabela de todos os grupos da antena de tag veicular por Instância conectada

2. Atualizar Grupos (por Instância)

Descrição:

Quando Usar:

Atualizar uma lista de grupos da antena de tag veicular por Instância conectada

3. Obter Grupo Específico (por Instância)

Descrição:

Quando Usar:

Obter um Grupo da antena de tag veicular por Instância conectada

4. Atualizar grupo específico (por Instância)

Descrição:

Quando Usar:

Atualizar um grupo da antena de tag veicular por Instância conectada

5. Obter Todos os Grupos (por ID)

Descrição:

Quando Usar:

Obter tabela de todos os grupos da antena de tag veicular

6. Atualizar Grupos (por ID)

Descrição:

Quando Usar:

Atualizar uma lista de grupos da antena de tag veicular

7. Obter Grupo Específico (por ID)

Descrição:

Quando Usar:

Obter um Grupo da antena de tag veicular

8. Atualizar grupo específico (por ID)

Descrição:

Quando Usar:

Atualizar um grupo da antena de tag veicular