Method: userProfiles.guardianInvitations.patch

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

В настоящее время единственной допустимой модификацией является изменение state с PENDING на COMPLETE . Это приведет к отзыву приглашения.

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED если у текущего пользователя нет разрешения на управление хранителями, если стражи не включены для рассматриваемого домена или в случае других ошибок доступа .
  • FAILED_PRECONDITION , если защитная ссылка не находится в состоянии PENDING .
  • INVALID_ARGUMENT если формат предоставленного идентификатора студента не может быть распознан (это не адрес электронной почты или идентификатор userId из этого API), или если переданное GuardianInvitation имеет state отличное от COMPLETE , или если оно изменяет поля, отличные от state .
  • NOT_FOUND , если предоставленный идентификатор учащегося является действительным идентификатором учащегося, но в Классе нет записи об этом учащемся или если поле id не относится к приглашению опекуна, известному Классу.

HTTP-запрос

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
studentId

string

Идентификатор учащегося, приглашение опекуна которого необходимо изменить.

invitationId

string

Поле id GuardianInvitation , которое необходимо изменить.

Параметры запроса

Параметры
updateMask

string ( FieldMask format)

Маска, определяющая, какие поля курса необходимо обновить. Это поле необходимо для обновления. Обновление завершается неудачно, если указаны недопустимые поля. Следующие поля действительны:

  • state

Если это поле задано в параметре запроса, оно должно быть указано как

updateMask=<field1>,<field2>,...

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

Тело запроса

Тело запроса содержит экземпляр GuardianInvitation .

Тело ответа

В случае успеха тело ответа содержит экземпляр GuardianInvitation .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Дополнительную информацию см. в руководстве по авторизации .