REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Una invitación para convertirse en el tutor de un usuario específico, enviada a una dirección de correo electrónico específica.

Representación JSON
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Campos
studentId

string

DNI del alumno (en formato estándar)

invitationId

string

Identificador único para esta invitación.

Solo lectura.

invitedEmailAddress

string

Dirección de correo electrónico a la que se envió la invitación. Este campo solo es visible para los administradores de dominio.

state

enum ( GuardianInvitationState )

El estado en el que se encuentra esta invitación.

creationTime

string ( Timestamp format)

La hora en que se creó esta invitación.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

TutorInvitaciónEstado

Estado de una invitación de tutor.

Enumeraciones
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca debe ser devuelto.
PENDING La invitación está activa y esperando una respuesta.
COMPLETE La invitación ya no está activa. Puede haber sido aceptado, rechazado, retirado o puede haber caducado.

Métodos

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 alumno.

get

Devuelve una invitación de guardián específica.

list

Devuelve una lista de invitaciones para tutores que el usuario solicitante puede ver, filtrada por los parámetros proporcionados.

patch

Modifica una invitación de tutor.