- Solicitud HTTP
- Parámetros de consulta
- cuerpo de la solicitud
- Cuerpo de respuesta
- Ámbitos de autorización
- ¡Intentalo!
Devuelve una lista de invitaciones que el usuario solicitante puede ver, restringida a aquellas que coinciden con la solicitud de lista.
Nota: Se debe proporcionar al menos uno de userId
de usuario o courseId
de curso. Se pueden proporcionar ambos campos.
Este método devuelve los siguientes códigos de error:
-
PERMISSION_DENIED
por errores de acceso .
Solicitud HTTP
GET https://classroom.googleapis.com/v1/invitations
La URL usa la sintaxis de transcodificación de gRPC .
Parámetros de consulta
Parámetros | |
---|---|
userId | Restringe las invitaciones devueltas a las de un usuario específico. El identificador puede ser uno de los siguientes:
|
courseId | Restringe las invitaciones devueltas a aquellas para un curso con el identificador especificado. |
pageSize | Número máximo de artículos a devolver. El valor predeterminado es 500 si no se especifica o El servidor puede devolver un número de resultados inferior al especificado. |
pageToken | La solicitud de |
cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de respuesta
Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Respuesta al listar invitaciones.
Representación JSON |
---|
{
"invitations": [
{
object ( |
Campos | |
---|---|
invitations[] | Invitaciones que coinciden con la solicitud de lista. |
nextPageToken | Token que identifica la siguiente página de resultados a devolver. Si está vacío, no hay más resultados disponibles. |
Ámbitos de autorización
Requiere uno de los siguientes ámbitos de OAuth:
-
https://www.googleapis.com/auth/classroom.rosters
-
https://www.googleapis.com/auth/classroom.rosters.readonly
Para obtener más información, consulte la Descripción general de OAuth 2.0 .