Method: courses.patch

Met à jour un ou plusieurs champs d'un cours.

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 cours demandé ou en cas d'erreur d'accès.
  • NOT_FOUND si aucun cours n'existe avec l'ID demandé.
  • 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.
  • FAILED_PRECONDITION pour les erreurs de requête suivantes :
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner
    • CourseTitleCannotContainUrl

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
id

string

Identifiant du cours à modifier. Cet identifiant peut être celui attribué par Classroom ou un alias.

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Masque qui identifie les champs du cours à mettre à jour. Ce champ est obligatoire pour effectuer une mise à jour. La mise à jour échouera si des champs non valides sont spécifiés. Les champs suivants sont valides :

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

Remarque : Les modifications apportées à ownerId sont considérées comme effectives immédiatement, mais en pratique, le transfert de propriété de toutes les ressources concernées peut prendre un certain temps.

Lorsqu'il est défini dans un paramètre de requête, ce champ doit être spécifié comme suit :

updateMask=<field1>,<field2>,...

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

Corps de la requête

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

Corps de la réponse

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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