Method: courses.studentGroups.patch

Met à jour un ou plusieurs champs dans un groupe d'élèves.

Cette méthode renvoie les codes d'erreur suivants :

  • PERMISSION_DENIED si l'utilisateur qui envoie la requête n'est pas autorisé à modifier le groupe d'élèves demandé ou en cas d'erreur d'accès.
  • NOT_FOUND si le groupe d'élèves n'existe pas ou si l'utilisateur n'y a pas accès.
  • INVALID_ARGUMENT si des champs non valides sont spécifiés dans le masque de mise à jour ou si aucun masque de mise à jour n'est fourni.

Requête HTTP

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Obligatoire. Identifiant du cours.
id

string

Obligatoire. Identifiant du groupe d'élèves.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Obligatoire. Masque qui identifie les champs du groupe d'élèves à mettre à jour. Ce champ est obligatoire pour effectuer une mise à jour. La mise à jour échoue si des champs non valides sont spécifiés.

Les enseignants peuvent spécifier les champs suivants :

  • title

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
previewVersion

enum (PreviewVersion)

Facultatif. Version d'aperçu du point de terminaison. Ce paramètre doit être défini pour accéder aux nouvelles fonctionnalités d'API mises à la disposition des développeurs dans le programme Preview.

Corps de la requête

Le corps de la requête contient une instance de StudentGroup.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de StudentGroup.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/classroom.rosters

Pour en savoir plus, consultez le guide d'autorisation.