Exemplos de grupos

Esta página percorre cada chamada de Usergroups com uma requisição e uma resposta de exemplo. Os exemplos de criação e atualização enviam o corpo como uma query string em texto puro (type=A&status=D&usergroup=Managers) com o Content-Type text/plain, exatamente como a referência mostra.

Listar todos os grupos de usuários

Retorna a lista de todos os grupos de usuários.

Exemplo de requisição

curl "$BASE_URL/api/usergroups" \
  -u "$EMAIL:$API_KEY"

Consultar um grupo de usuários

Retorna os detalhes de um grupo de usuários específico pelo ID.

Exemplo de requisição

curl "$BASE_URL/api/usergroups/3" \
  -u "$EMAIL:$API_KEY"

Criar um grupo de usuários

Cria um novo grupo de usuários no sistema.

Exemplo de requisição

Este exemplo cria um novo grupo de administradores chamado Managers. O status do grupo é Desativado.

curl -X POST "$BASE_URL/api/usergroups" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: text/plain" \
  --data-binary 'type=A&status=D&usergroup=Managers'

Resposta

{
  "usergroup_id": 5
}

Atualizar um grupo de usuários

Atualiza um grupo de usuários existente com novas propriedades. Os campos obrigatórios são type e status. Os campos disponíveis são status, type e usergroup.

Exemplo de requisição

Este exemplo muda o status do grupo com usergroup_id=5 (no nosso caso, o grupo "Managers") para Ativo.

curl -X PUT "$BASE_URL/api/usergroups/5" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: text/plain" \
  --data-binary 'type=A&status=A'

Resposta

{
  "usergroup_id": 5
}

Excluir um grupo de usuários

Exclui um grupo de usuários específico do sistema.

Exemplo de requisição

Este exemplo exclui o grupo de usuários com usergroup_id=5.

curl -X DELETE "$BASE_URL/api/usergroups/5" \
  -u "$EMAIL:$API_KEY"

Erros

Veja também

• Campos do grupo
• Usuários e grupos