Method: userProfiles.guardianInvitations.list

Muestra una lista de invitaciones a tutores que el usuario solicitante puede ver, filtrada según los parámetros proporcionados.

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

  • PERMISSION_DENIED si se especifica un studentId y el usuario solicitante no puede ver las invitaciones a tutores de ese alumno, 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 o si se producen otros errores de acceso.
  • Es INVALID_ARGUMENT si se especifica un studentId, pero no se reconoce 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 proporcionan pageToken o state no válidos.
  • Es NOT_FOUND si se especifica una 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}/guardianInvitations

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
studentId

string

El ID del alumno cuyas invitaciones se deben devolver como tutores. 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 alumnos que el usuario solicitante puede ver las invitaciones a los tutores

Parámetros de consulta

Parámetros
invitedEmailAddress

string

Si se especifica, solo se muestran resultados con el invitedEmailAddress especificado.
states[]

enum (GuardianInvitationState)

Si se especifica, solo se muestran resultados con los valores state especificados. De lo contrario, se muestran resultados con un state de PENDING.
pageToken

string

Valor de nextPageToken que se muestra en una llamada a list anterior, 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 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

Respuesta cuando se enumeran las invitaciones a tutores

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

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

object (GuardianInvitation)

Invitaciones a tutores que coincidieron con la solicitud de lista
nextPageToken

string

Token que identifica la página siguiente de resultados para mostrar. Si está vacío, no hay más resultados disponibles.

Permisos de la 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.