O que esse endpoint de API faz

Com a API Group Memberships, você pode adicionar e remover usuários de um grupo. Os administradores veem isso refletido na guia Pessoas, no registro individual do usuário ou do grupo. Todos os cursos atribuídos ao grupo aparecerão na biblioteca do usuário.

Você também pode usar essa API para recuperar uma lista dos membros de um grupo ou dos grupos nos quais um usuário individual está inscrito.

• Endpoints
• Listar os membros de um grupo
• Listar os grupos de um usuário
• Adicionar um usuário a um grupo
• Remover um usuário de um grupo

Endpoints

• GET /groups/{groupId}/users- listar os membros de um grupo
• GET /users/{userId}/groups - listar os grupos de um usuário
• PUT /groups/{groupId}/users/{userId} - adicionar um usuário a um grupo
• DELETE /groups/{groupId}/users/{userId}- remover um usuário de um grupo

Listar os membros de um grupo

GET /groups/{groupId}/users

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)

Exemplo de resposta

< https://api.reach360.com/reports/learners/example-user-id-1 > < https://api.reach360.com/users/example-user-id-1 >{ 
 “users”: [
{
“id”: “example-user-id-1", “email”: "foo@example.com 
 “, “groupsURL”: “”, “< https://api.reach360.com/users/example-user-id-1/groups > 
 role”: 
 “aluno”, “FirstName”: “Exemplo de nome 1", “LastName”: “Exemplo de sobrenome 1", 
 “lastActiveAt”: “2021-10-28T 20:39:52.659 Z”, 
 “learnerReportUrl”: 
 “”, “url”: “” “Articulate360User”: false 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 “próximo URL”: “”} 

Códigos de erro específicos do endpoint:

• group_not_found- não é possível listar usuários porque o grupo não existe

Listar os grupos de um usuário

GET /users/{userId}/groups

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 100 (o padrão é 50)

Exemplo de resposta

< https://api.reach360.com/groups/example-group-id-1 >{ 
 “groups”: [
{
“id”: “example-group-id-1", 
 “membersURL”: “”, “< https://api.reach360.com/groups/example-group-id/users > name”: “Exemplo de grupo”, 
 “url”: “”},... 
 
 
< https://url-for-next-page-of-results >], 
 “próximo URL”: “”} 

Códigos de erro específicos do endpoint:

• user_not_found- não é possível listar grupos de usuários porque o usuário não existe

Adicionar usuário ao grupo

PUT /groups/{groupId}/users/{userId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint:

• group_not_found- não é possível adicionar usuário ao grupo porque o grupo não existe
• user_not_found- não é possível adicionar usuário ao grupo porque o usuário não existe

Remover usuário do grupo

DELETE /groups/{groupId}/users/{userId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint:

• group_not_found- não é possível remover o usuário do grupo porque o grupo não existe
• user_not_found- não é possível remover o usuário do grupo porque o usuário não existe