- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Renvoie une liste d'invitations que l'utilisateur à l'origine de la demande est autorisé à consulter, limitée à celles qui correspondent à la demande de liste.
Remarque:Vous devez fournir au moins l'un des champs userId
ou courseId
. Vous pouvez fournir les deux champs.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED
pour les erreurs d'accès.
Requête HTTP
GET https://classroom.googleapis.com/v1/invitations
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres | |
---|---|
userId |
Limite les invitations renvoyées à celles d'un utilisateur spécifique. Il peut s'agir de l'un des éléments suivants:
|
courseId |
Limite les invitations renvoyées aux personnes qui participent à un cours avec l'identifiant spécifié. |
pageSize |
Nombre maximal d'éléments à renvoyer. La valeur par défaut est 500 si aucune valeur n'est spécifiée ou Le serveur peut renvoyer un nombre de résultats inférieur au nombre spécifié. |
pageToken |
Valeur Par ailleurs, la requête |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse lorsque des invitations sont listées.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"invitations": [
{
object ( |
Champs | |
---|---|
invitations[] |
Invitations correspondant à la demande de liste. |
nextPageToken |
Jeton identifiant la page suivante de résultats à renvoyer. Si ce champ n'est pas renseigné, aucun autre résultat n'est disponible. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Pour en savoir plus, consultez le guide relatif aux autorisations.