Method: userProfiles.guardians.list

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

Si deseas enumerar los tutores de cualquier alumno para los que el usuario solicitante pueda ver los tutores, usa el carácter literal - en el ID del alumno.

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

  • PERMISSION_DENIED si se especifica un studentId y el usuario solicitante no puede ver la información del tutor de ese estudiante, si se especifica "-" como studentId y el usuario no es un administrador del dominio, si los tutores no están habilitados para el dominio en cuestión, si el filtro invitedEmailAddress lo establece un usuario que no es administrador del dominio o si hay otros errores de acceso.
  • Es INVALID_ARGUMENT si se especifica un studentId, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni una studentId de la API, ni la string 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 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

string

Filtra los resultados por el alumno 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 string "me", que indica el usuario solicitante
  • El literal de string "-", que indica que se deben mostrar resultados para todos los estudiantes 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 tutores. Solo los administradores del dominio pueden utilizar este filtro.
pageToken

string

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

La solicitud list debe ser idéntica a la que generó este token.
pageSize

integer

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 muestra la lista de 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)

Los tutores de esta página de resultados que cumplen con los criterios especificados en la solicitud.
nextPageToken

string

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.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.