- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Pruébala
Crea una invitación y le 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. Además, se creará un recurso Guardian
para representar al tutor activo.
El objeto de solicitud debe tener configurados los campos studentId
y invitedEmailAddress
. Si no estableces estos campos o configuras cualquier otro campo 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 tutores, si el tutor en cuestión ya rechazó demasiadas solicitudes para ese estudiante, si los tutores no están habilitados para el dominio en cuestión o por otros errores de acceso.RESOURCE_EXHAUSTED
si el estudiante o tutor superó el límite de vínculos correspondientesINVALID_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 del ID de alumno proporcionado (no es una dirección de correo electrónico ni unauserId
de esta API). Este error también se mostrará si se configuran campos de solo lectura o si el campostate
se establece en un valor diferente dePENDING
.NOT_FOUND
si la ID de alumno proporcionada es válida, pero Classroom no tiene registros de ese alumno.ALREADY_EXISTS
si ya hay una invitación pendiente para el tutor del estudiante y se proporcionóinvitedEmailAddress
, o bien si elinvitedEmailAddress
proporcionado coincide con la Cuenta de Google de unGuardian
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 |
ID del estudiante (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 guía de autorización.