- 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 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 los valores userId
o courseId
. Se pueden proporcionar ambos campos.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIED
para errores de acceso.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/invitations
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros | |
---|---|
userId |
Restringe las invitaciones que se muestran a las de un usuario específico. El identificador puede ser uno de los siguientes:
|
courseId |
Restringe las invitaciones devueltas a aquellas personas que corresponden a un curso con el identificador especificado. |
pageSize |
Cantidad máxima de artículos que se devolverán. Si no se especifica, el valor predeterminado es 500 o Es posible que el servidor muestre menos resultados que la cantidad especificada. |
pageToken |
Es el valor La solicitud |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Respuesta cuando se enumeran las invitaciones.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
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 que se mostrarán. Si este campo 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.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Para obtener más información, consulta la guía de autorización.