API de grupos

Os grupos permitem que você organize os usuários em conjunto para placares e concursos coletivos. Esta API fornece terminais para criação de grupos, gerenciamento de membros e manipulação de placares de grupo.

Visão geral

Os grupos no omegaUp têm dois propósitos principais:

1. Organização de usuários: agrupe usuários para rastreamento e gerenciamento
2. Painéis de avaliação: crie placares personalizados que agregam resultados de vários concursos

Pontos de extremidade do grupo

Criar grupo

Cria um novo grupo. O usuário autenticado se torna o administrador do grupo.

POST /api/group/create/

Parâmetros:

Resposta:

{
  "status": "ok"
}

Atualizar grupo

Atualiza as informações de um grupo existente.

POST /api/group/update/

Parâmetros:

Privilégios: Administrador do grupo

Obtenha detalhes do grupo

Retorna informações detalhadas sobre um grupo, incluindo seus placares.

GET /api/group/details/

Parâmetros:

Resposta:

{
  "group": {
    "create_time": 1609459200,
    "alias": "my-group",
    "name": "My Group",
    "description": "A sample group"
  },
  "scoreboards": [
    {
      "alias": "scoreboard-1",
      "create_time": "2021-01-01T00:00:00Z",
      "description": "Main scoreboard",
      "name": "Main Scoreboard"
    }
  ]
}

Listar grupos de usuários

Retorna todos os grupos administrados pelo usuário atual.

GET /api/group/myList/

Resposta:

{
  "groups": [
    {
      "alias": "group-1",
      "create_time": { "time": 1609459200 },
      "description": "Description",
      "name": "Group Name"
    }
  ]
}

Pesquisar grupos

Retorna grupos que correspondem a uma consulta de pesquisa. Usado para digitação antecipada.

GET /api/group/list/

Parâmetros:

Resposta:

[
  {
    "label": "Group Name",
    "value": "group-alias"
  }
]

Obtenha membros do grupo

Retorna todos os membros de um grupo.

GET /api/group/members/

Parâmetros:

Resposta:

{
  "identities": [
    {
      "username": "user1",
      "name": "User One",
      "country": "MX",
      "country_id": "MX",
      "school": "School Name",
      "school_id": 123
    }
  ]
}

Adicionar usuário ao grupo

Adiciona um usuário a um grupo.

POST /api/group/addUser/

Parâmetros:

Resposta:

{
  "status": "ok"
}

Erros:

• identityInGroup: O usuário já é membro do grupo

Remover usuário do grupo

Remove um usuário de um grupo.

POST /api/group/removeUser/

Parâmetros:

Privilégios: Administrador do grupo

Criar placar

Cria um novo placar para um grupo.

POST /api/group/createScoreboard/

Parâmetros:

Privilégios: Administrador do grupo

Pontos finais do painel de avaliação do grupo

Os placares de grupo agregam resultados de vários concursos.

Adicionar concurso ao placar

Adiciona um concurso a um placar de grupo.

POST /api/groupScoreboard/addContest/

Parâmetros:

Privilégios: Administrador do grupo + acesso ao concurso

Remover concurso do placar

Remove uma competição de um placar de grupo.

POST /api/groupScoreboard/removeContest/

Parâmetros:

Privilégios: Administrador do grupo

Obtenha detalhes do placar

Retorna detalhes do placar, incluindo classificação e concursos.

GET /api/groupScoreboard/details/

Parâmetros:

Resposta:

{
  "ranking": [
    {
      "username": "user1",
      "name": "User One",
      "contests": {
        "contest-1": { "points": 100, "penalty": 50 }
      },
      "total": { "points": 100, "penalty": 50 }
    }
  ],
  "scoreboard": {
    "alias": "scoreboard-1",
    "name": "Main Scoreboard",
    "description": "Description"
  },
  "contests": [...]
}

Listar placares de grupos

Retorna todos os placares de um grupo.

GET /api/groupScoreboard/list/

Parâmetros:

Privilégios: Administrador do grupo

Casos de uso

Criando um grupo de turma

# 1. Create the group
curl -X POST https://omegaup.com/api/group/create/ \
  -d "alias=algorithms-2024&name=Algorithms 2024&description=Spring semester class"

# 2. Add students
curl -X POST https://omegaup.com/api/group/addUser/ \
  -d "group_alias=algorithms-2024&usernameOrEmail=student1@example.com"

# 3. Create a scoreboard
curl -X POST https://omegaup.com/api/group/createScoreboard/ \
  -d "group_alias=algorithms-2024&alias=homework&name=Homework Scores"

# 4. Add contests to scoreboard
curl -X POST https://omegaup.com/api/groupScoreboard/addContest/ \
  -d "group_alias=algorithms-2024&scoreboard_alias=homework&contest_alias=hw1&weight=1.0"

Documentação Relacionada

• API Teams - Para gerenciar grupos de equipes
• API de concursos - Criação de concursos para grupos
• API de usuários - Gerenciamento de usuários

Referência completa

Para obter detalhes completos do endpoint, consulte o código-fonte do Group Controller e do GroupScoreboard Controller.