Co robi ten punkt końcowy API

Za pomocą interfejsu API grup tworzysz lub usuwasz grupę i aktualizujesz nazwę grupy. Administratorzy widzą te zmiany odzwierciedlone na karcie Osoby. Ten punkt końcowy służy również do pobierania listy grup lub szczegółów określonej grupy.

• Punkty końcowe
• Grupuj obiekt
• Utwórz grupę
• Lista grup
• Pobierz według identyfikatora grupy
• Aktualizacja według identyfikatora grupy
• Usuń według identyfikatora grupy

Punkty końcowe

• POST /groups- utwórz nową grupę
• GET /groups- lista grup
• GET /groups/{groupId}- uzyskać szczegóły grupy według identyfikatora grupy
• PUT /groups/{groupId}- zaktualizuj grupę według identyfikatora grupy
• DELETE /groups/{groupId}- usuń grupę według identyfikatora grupy

Grupuj obiekt

• id(string) - unikalny identyfikator grupy
• membersUrl(string) - URL do listy członków grupy z API
• reportersUrl(string) - URL do listy reporterów dla grupy z API
• managersUrl(string) - URL do listy menedżerów grup z API
• name(string) - nazwa grupy
• url(string) - URL, aby pobrać dane grupy z API

Utwórz grupę

POST /groups

Parametry żądania (JSON)

• name(string, required) - nazwa grupy

Przykładowa odpowiedź

{
„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”: „Example Group”, 
 „url”: "https://api.reach360.com/groups/example-group-id"} 
 

Kody błędów specyficzne dla punktu końcowego

• code: 'duplicate_name'- nie można utworzyć grupy, ponieważ grupa o określonym name już istnieje

Lista grup

GET /groups

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)
• name(string, opcjonalne) - Zwraca grupy o określonej nazwie.

Przykładowa odpowiedź

{
„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”: 
 „Example Group” „url”: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Pobierz grupę według identyfikatora

GET /groups/{groupId}

Przykładowa odpowiedź

{
„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”: „Example Group” „url”: "https://api.reach360.com/groups/example-group-id"} 
 
 

Kody błędów specyficzne dla punktu końcowego

• group_not_found- nie można pobrać grupy, ponieważ grupa nie istnieje

Aktualizuj grupę według identyfikatora

PUT /groups/{groupId}

Parametry żądania (JSON)

• name(string, required) - nazwa grupy

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego:

• group_not_found- nie można zaktualizować grupy, ponieważ grupa nie istnieje
• read_only_group- nie można wprowadzać zmian w określonej grupie (Przykład: nie można modyfikować grupy „Wszyscy”)

Usuń grupę według identyfikatora

DELETE /groups/{groupId}

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego:

• group_not_found- nie można usunąć grupy, ponieważ grupa nie istnieje
• read_only_group- nie można usunąć określonej grupy (przykład: nie można modyfikować grupy „Wszyscy”)