Method: userProfiles.guardianInvitations.list

Muestra una lista de invitaciones de guardián que el usuario solicitante puede 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 solicitante no tiene permiso para ver las invitaciones para los tutores de ese estudiante, si se especifica "-" como el studentId y el usuario no es 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 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 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 el tutor se deben mostrar. 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 para los que el usuario solicitante tiene permiso para ver las invitaciones de los tutores.

Parámetros de consulta

Parámetros
invitedEmailAddress

string

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

enum (GuardianInvitationState)

Si se especifica, solo se muestran los resultados con los valores state especificados. De lo contrario, se muestran resultados con un state de PENDING.
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 las invitaciones para el tutor.

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 de guardián que coincidieron con la solicitud de lista
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.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Para obtener más información, consulta la Guía de autorización.