Cosa fa questo endpoint API

Con l'API Group Memberships puoi aggiungere e rimuovere utenti da un gruppo. Gli amministratori lo vedono riflesso nella scheda Persone sotto il record del singolo utente o del gruppo. Tutti i corsi assegnati al gruppo verranno visualizzati nella libreria dell'utente.

Puoi anche utilizzare questa API per recuperare un elenco dei membri di un gruppo o dei gruppi a cui è iscritto un singolo utente.

• Endpoint
• Elenca i membri di un gruppo
• Elenca i gruppi di un utente
• Aggiungere un utente a un gruppo
• Rimuovere un utente da un gruppo

Endpoint

• GET /groups/{groupId}/users- elenca i membri di un gruppo
• GET /users/{userId}/groups - elenca i gruppi di un utente
• PUT /groups/{groupId}/users/{userId} - aggiungi un utente a un gruppo
• DELETE /groups/{groupId}/users/{userId}- rimuovere un utente da un gruppo

Elenca i membri di un gruppo

GET /groups/{groupId}/users

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 100 (il valore predefinito è 50)

Esempio di risposta

< 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»: «learner», «firstName»: 
 «Nome di esempio 1", «lastName»: «Cognome di esempio 1", «lastActiveAT»: 
 «2021-10-28T 20:39:52.659 Z», «lastActiveAT»: 
 «2021-10-28T 20:39:52.659 Z», «learnerReportUrl»: 
 «», «url»: «» «Articulate360User»: falso 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 «nextUrl»: «»} 

Codici di errore specifici dell'endpoint:

• group_not_found- non è possibile elencare gli utenti perché il gruppo non esiste

Elenca i gruppi di un utente

GET /users/{userId}/groups

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 100 (il valore predefinito è 50)

Esempio di risposta

< 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»: «Gruppo di esempio», 
 «url»: «»},
... 
 
< https://url-for-next-page-of-results >], «nextUrl»: «»} 
 

Codici di errore specifici dell'endpoint:

• user_not_found- impossibile elencare i gruppi di utenti perché l'utente non esiste

Aggiungi utente al gruppo

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint:

• group_not_found- non è possibile aggiungere un utente al gruppo perché il gruppo non esiste
• user_not_found- impossibile aggiungere un utente al gruppo perché l'utente non esiste

Rimuovi utente dal gruppo

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint:

• group_not_found- impossibile rimuovere l'utente dal gruppo perché il gruppo non esiste
• user_not_found- impossibile rimuovere un utente dal gruppo perché l'utente non esiste