- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Modifie une invitation de représentant légal.
Actuellement, la seule modification valide consiste à remplacer PENDING
par COMPLETE
dans state
. L'invitation est alors annulée.
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'autres erreurs d'accès.FAILED_PRECONDITION
si le lien de représentant légal n'est pas à l'étatPENDING
.INVALID_ARGUMENT
si le format de la pièce d'identité de l'élève fourni ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail ni d'unuserId
de cette API), ou si leGuardianInvitation
transmis possède unstate
autre queCOMPLETE
, ou s'il modifie des champs autres questate
.NOT_FOUND
si le numéro d'élève fourni est valide, mais que Classroom ne dispose d'aucune information sur cet élève, ou si le champid
ne fait pas référence à une invitation de responsable parental connue de 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 | |
---|---|
student |
ID de l'élève dont l'invitation au représentant légal doit être modifiée. |
invitation |
Champ |
Paramètres de requête
Paramètres | |
---|---|
update |
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:
Lorsqu'il est défini dans un paramètre de requête, ce champ doit être spécifié comme
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : |
Corps de la requête
Le corps de la requête contient une instance de 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 d'autorisation.