Method: userProfiles.guardians.list

Muestra una lista de tutores que el usuario solicitante puede ver, restringida a aquellos que coinciden con la solicitud.

Para enumerar los tutores de cualquier estudiante para el que el usuario solicitante pueda ver tutores, usa el carácter literal - para el ID del estudiante.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED si se especifica un studentId y el usuario solicitante no tiene permiso para ver la información del tutor de ese estudiante, si se especifica "-" como studentId y el usuario no es administrador del dominio, si los tutores no están habilitados para el dominio en cuestión, si un usuario que no es administrador del dominio establece el filtro invitedEmailAddress o por otros errores de acceso.
  • INVALID_ARGUMENT si se especifica un studentId, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni un studentId de la API, ni la cadena literal me). También se puede mostrar si se proporciona un pageToken no válido.
  • NOT_FOUND si se especifica un studentId y se puede reconocer su formato, pero Classroom no tiene registro de ese estudiante.

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

string

Filtra los resultados por el estudiante al que está vinculado el tutor. El identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante
  • la cadena literal "-", que indica que se deben mostrar los resultados de todos los estudiantes a los que el usuario solicitante tiene acceso para ver.

Parámetros de consulta

Parámetros
invitedEmailAddress

string

Filtra los resultados por la dirección de correo electrónico a la que se envió la invitación original, lo que generará este vínculo para el tutor. Solo los administradores de dominio pueden usar este filtro.
pageToken

string

Es el valor de nextPageToken que se muestra de una llamada list anterior y que indica que se debe mostrar la página de resultados posterior.

De lo contrario, la solicitud list debe ser idéntica a la que generó este token.
pageSize

integer

Es la cantidad máxima de elementos que se mostrarán. Cero o no especificado indica que el servidor puede asignar un máximo.

Es posible que el servidor muestre menos de la cantidad especificada de resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta cuando se enumeran los tutores

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Campos
guardians[]

object (Guardian)

Tutores en esta página de resultados que cumplieron con los criterios especificados en la solicitud
nextPageToken

string

Es un token que identifica la siguiente página de resultados que se mostrará. Si está vacío, significa que no hay más resultados disponibles.

Permisos de autorización

Se necesita uno de los siguientes permisos 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 Guía de autorización.