Method: userProfiles.guardianInvitations.list

Devuelve una lista de invitaciones a tutores que el usuario solicitante tiene permitido ver, filtradas 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 que realiza la solicitud no tiene permiso para ver las invitaciones del tutor para 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 o por otros errores de acceso.
  • INVALID_ARGUMENT si se especifica una 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 o state 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}/guardianInvitations

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

Parámetros de ruta de acceso

Parámetros
studentId

string

El ID del estudiante cuyas invitaciones para ser tutor se deben devolver. 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 estudiantes que el usuario solicitante tenga permiso para ver las invitaciones para 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 state de PENDING.
pageToken

string

Es el valor de nextPageToken que se muestra desde 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 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

Responder cuando se enumeren las invitaciones a los 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 para tutores que coinciden con la solicitud de lista.
nextPageToken

string

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

Alcances de autorización

Se necesita uno de los siguientes permisos 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.