REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Es una invitación para convertirse en tutor de un usuario especificado, 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. Este campo solo es visible para los administradores del dominio.
state

enum (GuardianInvitationState)

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

string (Timestamp format)

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

Solo lectura.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 de tutor.

Enumeraciones
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca se debe devolver.
PENDING La invitación está activa y pendiente de respuesta.
COMPLETE La invitación ya no está activa. Es posible que se haya aceptado, rechazado, cancelado o vencido.

Métodos

create

 Crea una invitación para el tutor y le envía un correo electrónico en el que se le solicita que confirme que es el tutor del estudiante.

get

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

list

 Devuelve una lista de las invitaciones de tutor que el usuario solicitante tiene permiso para ver, filtradas según los parámetros proporcionados.

patch

 Modifica una invitación de tutor.