Method: userProfiles.guardianInvitations.list

Muestra una lista de invitaciones para tutores que el usuario que realiza la solicitud puede ver, filtradas por los parámetros proporcionados.

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

  • PERMISSION_DENIED si se especifica un studentId y el usuario que realiza la solicitud no tiene permiso para ver las invitaciones de los tutores de ese alumno, 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 o a causa de 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 string literal me). También se puede mostrar si se proporciona un pageToken o state no válido.
  • NOT_FOUND si se especifica un studentId 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}/guardianInvitations

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

Parámetros de ruta de acceso

Parámetros
studentId

string

Es el ID del alumno cuyas invitaciones para tutores se devuelvan. 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 los resultados para todos los alumnos que el usuario que solicita permiso puede ver las invitaciones de los tutores.

Parámetros de consulta

Parámetros
invitedEmailAddress

string

Si se especifica, solo se muestran los resultados con la invitedEmailAddress especificada.

states[]

enum (GuardianInvitationState)

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

pageToken

string

Valor nextPageToken que muestra una llamada list anterior, que indica que se debe mostrar la página de resultados posterior.

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

pageSize

integer

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 las invitaciones para tutores

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

object (GuardianInvitation)

Invitaciones de los tutores que coincidieron con la solicitud de la lista

nextPageToken

string

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