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 específica.

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)

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

string (Timestamp format)

Indica el momento en 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 fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Estado de una invitación para ser tutor.

Enumeradores
GUARDIAN_INVITATION_STATE_UNSPECIFIED No se debe mostrar nunca.
PENDING La invitación se encuentra activa y a la espera de una respuesta.
COMPLETE La invitación ya no está activa. Es posible que se haya aceptado, rechazado o retirado, o bien que haya vencido.

Métodos

create

 Crea una invitación y le envía un correo electrónico al tutor para pedirle que confirme que es el tutor del alumno.

get

 Devuelve una invitación específica para tutores.

list

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

patch

 Modifica una invitación para tutores.