REST Resource: userProfiles.guardianInvitations

Ресурс: GuardianInvitation

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

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

string

ID студента (в стандартном формате)

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

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