Method: userProfiles.guardianInvitations.create

Crea una invitación de tutor y envía un correo electrónico al tutor pidiéndole 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 para tutores. También se creará un recurso de Guardian para representar al tutor activo.

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

Este método devuelve 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 ha rechazado demasiadas solicitudes para ese estudiante, si los tutores no están habilitados para el dominio en cuestión u otros errores de acceso .
  • RESOURCE_EXHAUSTED si el estudiante o tutor ha excedido el límite de enlace de tutor.
  • 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 identificación de estudiante proporcionada (no es una dirección de correo electrónico ni una userId de usuario de esta API). Este error también se devolverá si se establecen campos de solo lectura o si el campo de state se establece en un valor que no sea PENDING .
  • NOT_FOUND si la identificación de estudiante proporcionada es una identificación de estudiante válida, pero Classroom no tiene registro de ese estudiante.
  • ALREADY_EXISTS si ya hay una invitación de tutor pendiente para el estudiante y la dirección de correo electrónico de invitedEmailAddress proporcionada, o si la dirección de correo electrónico de invitación proporcionada invitedEmailAddress 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 transcodificación de gRPC .

Parámetros de ruta

Parámetros
guardianInvitation.studentId

string

DNI del alumno (en formato estándar)

cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de GuardianInvitation .

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene una instancia de GuardianInvitation recién creada.

Ámbitos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulte la Descripción general de OAuth 2.0 .