Method: userProfiles.guardians.get

Возвращает конкретного опекуна.

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

  • PERMISSION_DENIED если запрашивающему пользователю не виден ни один пользователь, соответствующий предоставленному studentId , если запрашивающему пользователю не разрешено просматривать информацию об опекуне для учащегося, определенного идентификатором studentId , если опекуны не включены для рассматриваемого домена или при других ошибках доступа .
  • INVALID_ARGUMENT если указан studentId , но его формат не может быть распознан (это не адрес электронной почты, не studentId из API и не литеральная строка me ).
  • NOT_FOUND если запрашивающему пользователю разрешено просматривать опекунов для запрошенного studentId , но для этого учащегося не существует записи Guardian , соответствующей предоставленному guardianId .

HTTP-запрос

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

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

Параметры
studentId

string

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

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
guardianId

string

Поле id из Guardian .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

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

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

Требуется одна из следующих областей OAuth:

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

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