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

ID del alumno (en formato estándar)

invitationId

string

Es el identificador único de esta invitación.

Solo lectura

invitedEmailAddress

string

Dirección de correo electrónico a la que se envió la invitación Solo los administradores del dominio pueden ver este campo.

state

enum (GuardianInvitationState)

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

creationTime

string (Timestamp format)

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

Solo lectura

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

Estado de la invitación

Estado de la invitación de un tutor.

Enumeradores
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca se debe mostrar.
PENDING La invitación está activa y espera una respuesta.
COMPLETE La invitación ya no está activa. Es posible que se haya aceptado, rechazado, retirado o vencido.

Métodos

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.

get

Muestra una invitación de tutor específica.

list

Muestra una lista de invitaciones para tutores que el usuario que realiza la solicitud puede ver, filtradas por los parámetros proporcionados.

patch

Modifica la invitación de un tutor.