- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Pruébala
Muestra una lista de tutores que el usuario que realiza la solicitud puede ver, restringido a aquellos que coincidan con la solicitud.
Si quieres enumerar los tutores de cualquier alumno para los que el usuario solicitante pueda ver a los tutores, usa el carácter literal -
para el ID de alumno.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIED
si se especifica unstudentId
y el usuario que realiza la solicitud no tiene permiso para ver la información del tutor de ese alumno, si se especifica"-"
comostudentId
y el usuario no es administrador del dominio, si los tutores no están habilitados para el dominio en cuestión, si el usuario que no es administrador del dominio configuró el filtroinvitedEmailAddress
o si existen 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 unstudentId
de la API ni la string literalme
). También se puede mostrar si se proporciona unpageToken
no válido.NOT_FOUND
si se especifica unstudentId
y se puede reconocer su formato, pero Classroom no tiene ningún registro de ese alumno.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
studentId |
Filtra los resultados según el alumno al que está vinculado el tutor. El identificador puede ser uno de los siguientes:
|
Parámetros de consulta
Parámetros | |
---|---|
invitedEmailAddress |
Filtrar los resultados por la dirección de correo electrónico a la que se envió la invitación original, lo que genera este vínculo para tutores Solo los administradores del dominio pueden usar este filtro. |
pageToken |
Valor De lo contrario, la solicitud |
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 resultados que la cantidad especificada. |
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 tutores.
Representación JSON |
---|
{
"guardians": [
{
object ( |
Campos | |
---|---|
guardians[] |
Los tutores de esta página de resultados cumplieron con los criterios especificados en la solicitud. |
nextPageToken |
El token que identifica la página siguiente de resultados que se mostrará. Si está vacío, no hay más resultados disponibles. |
Alcances de la autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
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 descripción general de OAuth 2.0.