REST Resource: userProfiles.guardianInvitations

Ресурс: GuardianInvitation

Приглашение стать опекуном указанного пользователя, отправленное на указанный адрес электронной почты.

JSON-представление 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Поля
studentId

string

Удостоверение личности студента (в стандартном формате)

invitationId

string

Уникальный идентификатор этого приглашения.

Только для чтения.

invitedEmailAddress

string

Адрес электронной почты, на который было отправлено приглашение. Это поле доступно только администраторам домена.

state

enum ( GuardianInvitationState )

Штат, в котором находится это приглашение.

creationTime

string ( Timestamp format)

Время создания этого приглашения.

Только для чтения.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

GuardianInvitationState

Государство-опекун приглашено.

Перечисления
GUARDIAN_INVITATION_STATE_UNSPECIFIED Ни в коем случае не подлежит возврату.
PENDING Приглашение активно и ожидает ответа.
COMPLETE Приглашение больше не активно. Возможно, оно было принято, отклонено, отозвано, или срок его действия истёк.

Методы

create

 Создает приглашение опекуну и отправляет опекуну электронное письмо с просьбой подтвердить, что он является опекуном учащегося.

get

 Возвращает приглашение конкретному опекуну.

list

 Возвращает список приглашений опекунов, которые запрашивающему пользователю разрешено просматривать, отфильтрованный по предоставленным параметрам.

patch

 Изменяет приглашение опекуна.