- Solicitud HTTP
- Parámetros de búsqueda
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Pruébala
Muestra una lista de los cursos que el usuario solicitante puede ver, restringidos a los que coinciden con la solicitud. Los cursos devueltos se ordenan según la hora de creación, y la más reciente se crea primero.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIED
para errores de acceso.INVALID_ARGUMENT
si el argumento de la consulta es incorrectoNOT_FOUND
si no existen los usuarios especificados en los argumentos de consulta.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/courses
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros | |
---|---|
studentId |
Restringe los cursos devueltos a aquellos que tienen un alumno con el identificador especificado. El identificador puede ser uno de los siguientes:
|
teacherId |
Restringe los cursos devueltos a los profesores que tienen el identificador especificado. El identificador puede ser uno de los siguientes:
|
courseStates[] |
Restringe los cursos que se muestran a uno de los estados especificados. El valor predeterminado es ACTIVE, ARCHIVED, PROVISIONED y RECHAZADO. |
pageSize |
Cantidad máxima de elementos que se mostrarán. Cero o sin especificar indica que el servidor puede asignar un máximo. Es posible que el servidor muestre menos de la cantidad especificada de resultados. |
pageToken |
Valor De lo contrario, la solicitud de |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Respuesta al enumerar los cursos.
Representación JSON |
---|
{
"courses": [
{
object ( |
Campos | |
---|---|
courses[] |
Cursos que coinciden con la solicitud de la lista. |
nextPageToken |
Es el token que identifica la página siguiente de resultados que se mostrará. Si está vacío, no habrá más resultados disponibles. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Para obtener más información, consulta la Guía de autorización.