Method: invitations.list

Affiche la liste des invitations que l'utilisateur à l'origine de la requête est autorisé à consulter, limitées à celles qui correspondent à la requête de liste.

Remarque:Vous devez fournir au moins l'un des éléments 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. L'identifiant peut être l'un des éléments suivants:

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête
courseId

string

Limite les invitations renvoyées à celles d'un cours dont l'identifiant est spécifié.
pageSize

integer

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

Le serveur peut renvoyer un nombre inférieur au nombre de résultats 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.

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 lors de la liste des invitations.

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 requête de liste.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, 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 d'autorisation.