Cosa fa questo endpoint API

Con l'API Groups puoi creare o eliminare un gruppo e aggiornare il nome di un gruppo. Gli amministratori vedono queste modifiche riflesse nella scheda Persone. Questo endpoint viene utilizzato anche per recuperare un elenco di gruppi o i dettagli di un gruppo specifico.

• Endpoint
• Oggetto di gruppo
• Crea gruppo
• Elenca gruppi
• Recupera per ID di gruppo
• Aggiornamento per ID di gruppo
• Elimina per ID di gruppo

Endpoint

• POST /groups- crea un nuovo gruppo
• GET /groups- elenca i gruppi
• GET /groups/{groupId}- ottieni i dettagli di un gruppo per ID di gruppo
• PUT /groups/{groupId}- aggiorna un gruppo per id di gruppo
• DELETE /groups/{groupId}- elimina un gruppo per id di gruppo

Oggetto del gruppo

• id(stringa): l'identificatore univoco del gruppo
• membersUrl(string) - URL per elencare i membri del gruppo dall'API
• reportersUrl(string) - URL per elencare i reporter del gruppo dall'API
• managersUrl(stringa) - URL per elencare i gestori di gruppi dall'API
• name(string) - il nome del gruppo
• url(string) - URL per recuperare i dettagli del gruppo dall'API

Crea gruppo

POST /groups

Parametri di richiesta (JSON)

• name(stringa, obbligatorio): il nome del gruppo

Esempio di risposta

{
«id»: «example-group-id», 
 «memberSURL»: "https://api.reach360.com/groups/example-group-id/users «, «reporterSURL»: "https://api.reach360.com/groups/example-group-id/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id/managers «, 
 «name»: «Gruppo di esempio», 
 «url»: "https://api.reach360.com/groups/example-group-id"} 
 

Codici di errore specifici dell'endpoint

• code: 'duplicate_name'- impossibile creare un gruppo perché esiste già un gruppo con quanto specificato name

Elenca gruppi

GET /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)
• name(stringa, opzionale) - Restituisce i gruppi con il nome specificato.

Esempio di risposta

{
«groups»: [
{
«id»: «example-group-id-1", 
 «memberSURL»: "https://api.reach360.com/groups/example-group-id/users «, «reporterSURL»: "https://api.reach360.com/groups/example-group-id-1/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id-1/managers «, 
 «name»: «Gruppo di esempio» «url»: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], «nextURL»: "https://url-for-next-page-of-results"} 
 

Recupera gruppo per ID

GET /groups/{groupId}

Esempio di risposta

{
«id»: «example-group-id», 
 «memberSURL»: "https://api.reach360.com/groups/example-group-id/users «, «reporterSURL»: "https://api.reach360.com/groups/example-group-id/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id/managers «, 
 «name»: «Gruppo di esempio» «url»: "https://api.reach360.com/groups/example-group-id"} 
 
 

Codici di errore specifici dell'endpoint

• group_not_found- impossibile recuperare il gruppo perché il gruppo non esiste

Aggiorna gruppo per ID

PUT /groups/{groupId}

Parametri di richiesta (JSON)

• name(stringa, obbligatorio): il nome del gruppo

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint:

• group_not_found- impossibile aggiornare il gruppo perché il gruppo non esiste
• read_only_group- non può apportare modifiche al gruppo specificato (Esempio: non è possibile modificare il gruppo «Everyone»)

Elimina gruppo per ID

DELETE /groups/{groupId}

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint:

• group_not_found- impossibile eliminare il gruppo perché il gruppo non esiste
• read_only_group- non è possibile eliminare il gruppo specificato (Esempio: non è possibile modificare il gruppo «Everyone»)