Method: userProfiles.guardianInvitations.create

Crea una invitación para el tutor y envía un correo electrónico al tutor para pedirle que confirme que es el tutor del alumno.

Una vez que el tutor acepte la invitación, su state cambiará a COMPLETED y comenzará a recibir notificaciones para el tutor. También se creará un recurso Guardian para representar al tutor activo.

El objeto de la solicitud debe tener los campos studentId y invitedEmailAddress establecidos. Si no estableces estos campos o configuras otros en la solicitud, se producirá un error.

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

  • PERMISSION_DENIED si el usuario actual no tiene permiso para administrar a los tutores, si el tutor en cuestión ya rechazó demasiadas solicitudes de ese alumno, si los tutores no están habilitados para el dominio en cuestión o para otros errores de acceso.
  • RESOURCE_EXHAUSTED si el alumno o tutor supera el límite de vínculos para tutores
  • INVALID_ARGUMENT si la dirección de correo electrónico del tutor no es válida (por ejemplo, si es demasiado larga) o si no se puede reconocer el formato de la ID de estudiante proporcionada (no es una dirección de correo electrónico ni una userId de esta API). Este error también se mostrará si se configuran campos de solo lectura o si el campo state se estableció en un valor distinto de PENDING.
  • NOT_FOUND si el ID de estudiante proporcionado es válido, pero Classroom no tiene registro de ese estudiante.
  • ALREADY_EXISTS si ya hay una invitación de tutor pendiente para el alumno y se proporcionó invitedEmailAddress, o si la invitedEmailAddress proporcionada coincide con la Cuenta de Google de un Guardian existente para este usuario

Solicitud HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

Parámetros de ruta de acceso

Parámetros
guardianInvitation.studentId

string

ID del alumno (en formato estándar)

Cuerpo de la solicitud

El cuerpo de la solicitud incluye una instancia de GuardianInvitation.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de GuardianInvitation.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Para obtener más información, consulta la descripción general de OAuth 2.0.