Ce que fait ce point de terminaison d'API

L'API d'inscription aux cours permet d'inscrire ou de désinscrire un utilisateur ou un groupe à un cours. Lorsqu'il est utilisé, les administrateurs voient l'utilisateur ou le groupe ajouté ou supprimé dans l'onglet correspondant sur la page des détails du module. Les apprenants voient le module ajouté ou supprimé dans leur onglet Attribué à moi.

• Points de terminaison
• Groupe pour tous
• Inscrire un utilisateur
• Inscrire un groupe
• Désenregistrer un utilisateur
• Désinscrire un groupe

Points de terminaison

• PUT /courses/{courseId}/users/{userId}- inscrire un seul utilisateur à un module
• PUT /courses/{courseId}/groups/{groupId}- inscrire un groupe d'utilisateurs à un module
• DELETE /courses/{courseId}/users/{userId}- désinscrire un seul utilisateur d'un module
• DELETE /courses/{courseId}/groups/{groupId}- désinscrire un groupe d'utilisateurs d'un module

Groupe pour tous

Pour inscrire le groupe Everyone (c'est-à-dire tous les utilisateurs de votre compte Reach 360) à un module, utilisez everyone groupId

Inscrire un utilisateur

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

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison

• course_not_found- Impossible d'inscrire l'utilisateur au module car le cours n'existe pas
• user_not_found- Impossible d'inscrire l'utilisateur au module car l'utilisateur n'existe pas

Inscrire un groupe

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

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison

• course_not_found- Impossible d'inscrire le groupe au cours car le cours n'existe pas
• group_not_found- Impossible d'inscrire le groupe au module car le groupe n'existe pas

Désenregistrer un utilisateur

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

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison

• course_not_found- Impossible de désinscrire l'utilisateur du module car le cours n'existe pas
• user_not_found- Impossible de désinscrire l'utilisateur du module car l'utilisateur n'existe pas

Désinscrire un groupe

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

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison

• course_not_found- Impossible de désinscrire le groupe du module car le cours n'existe pas
• group_not_found- Impossible de désinscrire le groupe du module car le groupe n'existe pas