Co robi ten punkt końcowy interfejsu API

Interfejs API rejestracji kursu rejestruje lub wyrejestruje użytkownika lub grupę na kurs. Gdy jest używany, administratorzy widzą użytkownika lub grupę dodaną lub usuniętą z odpowiedniej karty na stronie szczegółów kursu. Uczestnicy widzą kurs dodany lub usunięty z zakładki Przypisane do mnie.

• Punkty końcowe
• Grupa Everyone
• Zarejestruj użytkownika
• Zarejestruj grupę
• Wyrejestrować użytkownika
• Unenroll Group

Punkty końcowe

• PUT /courses/{courseId}/users/{userId}- zapisać jednego użytkownika na kurs
• PUT /courses/{courseId}/groups/{groupId}- zapisać grupę użytkowników na kurs
• DELETE /courses/{courseId}/users/{userId}- wyrejestrować jednego użytkownika z kursu
• DELETE /courses/{courseId}/groups/{groupId}- wyrejestrować grupę użytkowników z kursu

Grupa Everyone

Aby zapisać grupę Wszyscy (tj. każdego użytkownika na koncie Reach 360) na kurs, użyj everyone groupId

Zarejestruj użytkownika

PUT /courses/{courseId}/users/{userId}

Odpowiedź na sukces

204 „Brak treści”

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

• course_not_found- nie można zapisać użytkownika na kurs, ponieważ kurs nie istnieje
• user_not_found- nie można zapisać użytkownika na kurs, ponieważ użytkownik nie istnieje

Zarejestruj grupę

PUT /courses/{courseId}/groups/{groupId}

Odpowiedź na sukces

204 „Brak treści”

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

• course_not_found- nie można zapisać grupy na kurs, ponieważ kurs nie istnieje
• group_not_found- nie można zapisać grupy na kurs, ponieważ grupa nie istnieje

Wyrejestrować użytkownika

DELETE /courses/{courseId}/users/{userId}

Odpowiedź na sukces

204 „Brak treści”

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

• course_not_found- nie można wyrejestrować użytkownika z kursu, ponieważ kurs nie istnieje
• user_not_found- nie można wyrejestrować użytkownika z kursu, ponieważ użytkownik nie istnieje

Unenroll Group

DELETE /courses/{courseId}/groups/{groupId}

Odpowiedź na sukces

204 „Brak treści”

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

• course_not_found- nie można wyrejestrować grupy z kursu, ponieważ kurs nie istnieje
• group_not_found- nie można wyrejestrować grupy z kursu, ponieważ grupa nie istnieje