Cosa fa questo endpoint API

L'API Course Enrollments registra o annulla l'iscrizione di un utente o di un gruppo a un corso. Quando viene utilizzato, gli amministratori vedono l'utente o il gruppo aggiunto o rimosso dalla scheda pertinente nella pagina dei dettagli del corso. Gli studenti vedono il corso aggiunto o rimosso dalla scheda Assegnato a me.

• Endpoint
• Gruppo Everyone
• Registra utente
• Iscrizione al gruppo
• Annulla la registrazione dell'utente
• Annulla l'iscrizione al gruppo

Endpoint

• PUT /courses/{courseId}/users/{userId}- iscrivere un singolo utente a un corso
• PUT /courses/{courseId}/groups/{groupId}- iscrivere un gruppo di utenti a un corso
• DELETE /courses/{courseId}/users/{userId}- annullare l'iscrizione di un singolo utente a un corso
• DELETE /courses/{courseId}/groups/{groupId}- annullare l'iscrizione di un gruppo di utenti a un corso

Gruppo Everyone

Per iscrivere il gruppo Everyone (ad esempio, ogni utente del tuo account Reach 360) a un corso, usa everyone groupId

Registra utente

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint

• course_not_found- non è possibile iscrivere l'utente al corso perché il corso non esiste
• user_not_found- non è possibile iscrivere l'utente al corso perché l'utente non esiste

Iscrizione al gruppo

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint

• course_not_found- non è possibile iscrivere un gruppo al corso perché il corso non esiste
• group_not_found- non è possibile iscrivere un gruppo al corso perché il gruppo non esiste

Annulla la registrazione dell'utente

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint

• course_not_found- non è possibile annullare l'iscrizione dell'utente al corso perché il corso non esiste
• user_not_found- non è possibile annullare l'iscrizione dell'utente al corso perché l'utente non esiste

Annulla la registrazione al gruppo

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

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint

• course_not_found- non è possibile annullare l'iscrizione al gruppo dal corso perché il corso non esiste
• group_not_found- non è possibile annullare l'iscrizione al gruppo dal corso perché il gruppo non esiste