- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Pruébala
Muestra una lista de invitaciones a tutores que el usuario solicitante puede ver, filtradas según los parámetros proporcionados.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIED
si se especifica unstudentId
y el usuario solicitante no puede ver las invitaciones para tutores de ese estudiante, si se especifica"-"
comostudentId
y el usuario no es un administrador de dominio, si los tutores no están habilitados para el dominio en cuestión o si se presentan otros errores de acceso.INVALID_ARGUMENT
si se especifica unstudentId
, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni unastudentId
de la API, ni la string literalme
). También se puede mostrar si se proporciona unpageToken
ostate
no válido.NOT_FOUND
si se especifica unstudentId
y se puede reconocer su formato, pero Classroom no tiene registro de ese alumno.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
studentId |
El ID del estudiante a cuyas invitaciones se deben devolver. El identificador puede ser uno de los siguientes:
|
Parámetros de consulta
Parámetros | |
---|---|
invitedEmailAddress |
Si se especifica, solo se muestran resultados con el |
states[] |
Si se especifica, solo se muestran resultados con los valores de |
pageToken |
Es el valor La solicitud |
pageSize |
Cantidad máxima de artículos que se devolverán. Cero o no especificado indica que el servidor puede asignar un máximo. Es posible que el servidor muestre menos resultados que la cantidad especificada. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Respuesta cuando se enumeran las invitaciones para tutores
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"guardianInvitations": [
{
object ( |
Campos | |
---|---|
guardianInvitations[] |
Invitaciones a tutores que coincidieron 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.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para obtener más información, consulta la guía de autorización.