Method: userProfiles.guardianInvitations.patch

Modifie l'invitation du représentant légal.

Actuellement, la seule modification valide consiste à remplacer state de PENDING par COMPLETE. Cette action entraîne l'annulation de l'invitation.

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

  • PERMISSION_DENIED si l'utilisateur actuel n'est pas autorisé à gérer les représentants légaux, si les représentants légaux ne sont pas activés pour le domaine en question ou en cas d'erreur d'accès.
  • FAILED_PRECONDITION si le lien du représentant légal n'est pas à l'état PENDING.
  • INVALID_ARGUMENT si le format de l'ID d'étudiant fourni n'est pas reconnu (il ne s'agit ni d'une adresse e-mail, ni d'un élément userId de cette API), si le paramètre GuardianInvitation transmis présente une valeur state autre que COMPLETE, ou s'il modifie des champs autres que state.
  • NOT_FOUND si la carte d'étudiant fournie est un numéro d'étudiant valide, mais que Classroom ne contient aucune trace de cet élève, ou si le champ id ne fait pas référence à une invitation d'un représentant légal connue dans Classroom.

Requête HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
studentId

string

L'ID de l'élève dont l'invitation en tant que représentant légal doit être modifiée.
invitationId

string

Champ id du GuardianInvitation à modifier.

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 échoue si des champs non valides sont spécifiés. Les champs suivants sont valides:

  • state

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 complets de champs séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

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

Corps de la réponse

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Pour en savoir plus, consultez le guide relatif aux autorisations.