REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Una invitación para convertirse en el tutor de un usuario específico que se envía a una dirección de correo electrónico especificada.

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

string

ID del estudiante (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)

Es el estado en el que se encuentra esta invitación.
creationTime

string (Timestamp format)

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

Solo lectura.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Es el estado de una invitación para el tutor.

Enumeraciones
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca debería mostrarse.
PENDING La invitación está activa y está pendiente de 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 le envía un correo electrónico para que confirme que es el tutor del estudiante.

get

 Devuelve una invitación específica para el tutor.

list

 Muestra una lista de invitaciones de guardián que el usuario solicitante puede ver, filtradas según los parámetros proporcionados.

patch

 Modifica una invitación para el tutor.