Method: courses.courseWork.list

Renvoie la liste des devoirs que le demandeur est autorisé à consulter.

Les élèves ne peuvent voir que PUBLISHED devoirs du cours. Les enseignants et les administrateurs du domaine peuvent consulter tous les devoirs du cours.

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

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si le format de la requête est incorrect.
  • NOT_FOUND si le cours demandé n'existe pas.

Requête HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Il peut s'agir de l'identifiant attribué par Classroom ou d'un alias.

Paramètres de requête

Paramètres
courseWorkStates[]

enum (CourseWorkState)

Restriction liée à l'état du devoir à rendre. Seuls les éléments CourseWork qui correspondent à la requête sont renvoyés. Si aucune valeur n'est spécifiée, les éléments dont l'état de travail est PUBLISHED sont renvoyés.
orderBy

string

Ordre de tri facultatif des résultats. Liste de champs séparés par une virgule avec un mot clé d'ordre de tri facultatif. Les champs compatibles sont updateTime et dueDate. Les mots clés d'itinéraire acceptés sont asc et desc. Si aucune valeur n'est spécifiée, updateTime desc est le comportement par défaut. Exemples: dueDate asc,updateTime desc, updateTime,dueDate desc
pageSize

integer

Nombre maximal d'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le 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.
previewVersion

enum (PreviewVersion)

Facultatif. Version preview de l'API. Il doit être défini pour accéder aux nouvelles fonctionnalités d'API mises à la disposition des développeurs dans le programme Preview.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à la liste des devoirs.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}
Champs
courseWork[]

object (CourseWork)

Éléments de travail du cours correspondant à la requête.
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.coursework.students.readonly
  • https://www.googleapis.com/auth/classroom.coursework.me.readonly
  • https://www.googleapis.com/auth/classroom.coursework.students
  • https://www.googleapis.com/auth/classroom.coursework.me

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