- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- Pruébalo
Crea una invitación para el tutor y le envía un correo electrónico para que confirme que es el tutor del estudiante.
Una vez que el tutor acepte la invitación, su state cambiará a COMPLETED y comenzará a recibir notificaciones de tutor. También se creará un recurso Guardian para representar al tutor activo.
El objeto de la solicitud debe tener configurados los campos studentId y invitedEmailAddress. Si no configuras estos campos o configuras cualquier otro campo en la solicitud, se mostrará un error.
Este método muestra los siguientes códigos de error:
PERMISSION_DENIEDsi el usuario actual no tiene permiso para administrar a los 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_EXHAUSTEDsi el estudiante o el tutor superaron el límite de vínculos del tutor.INVALID_ARGUMENTsi 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 estudiante proporcionado (no es una dirección de correo electrónico ni unuserIdde esta API). Este error también se mostrará si se configuran campos de solo lectura o si el campostatese establece en un valor distinto dePENDING.NOT_FOUNDsi el ID de estudiante proporcionado es válido, pero Classroom no tiene registro de ese estudiante.ALREADY_EXISTSsi ya hay una invitación pendiente para el tutor del estudiante y se proporcionóinvitedEmailAddress, o si elinvitedEmailAddressproporcionado coincide con la cuenta de Google de unGuardianexistente 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 contiene 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.