Method: invitations.list

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:

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

string

Limite les invitations renvoyées à celles d'un utilisateur spécifique. Il peut s'agir de l'un des éléments suivants:

  • l'identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • Le littéral de chaîne "me", indiquant l'utilisateur à l'origine de la demande
courseId

string

Limite les invitations renvoyées aux personnes qui participent à un cours avec l'identifiant spécifié.
pageSize

integer

Nombre maximal d'éléments à renvoyer. La valeur par défaut est 500 si aucune valeur n'est spécifiée ou 0.

Le serveur peut renvoyer un nombre de résultats inférieur au nombre spécifié.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

Par ailleurs, la requête list doit être identique à celle qui a généré ce jeton.

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 (Invitation)
    }
  ],
  "nextPageToken": string
}
Champs
invitations[]

object (Invitation)

Invitations correspondant à la demande de liste.
nextPageToken

string

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.