Method: userProfiles.guardianInvitations.list

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

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

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

HTTP-запрос

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

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

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

Параметры
studentId

string

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

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

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

Параметры
invitedEmailAddress

string

Если этот параметр указан, возвращаются только результаты с указанным invitedEmailAddress .

states[]

enum ( GuardianInvitationState )

Если указано, возвращаются только результаты с указанными значениями state . В противном случае возвращаются результаты в state PENDING .

pageToken

string

Значение nextPageToken , возвращенное из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов.

В остальном запрос list должен быть идентичен тому, который привел к получению этого токена.

pageSize

integer

Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум.

Сервер может вернуть меньшее количество результатов, чем указано.

Тело запроса

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

Тело ответа

Ответ при перечислении приглашений опекуна.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Поля
guardianInvitations[]

object ( GuardianInvitation )

Приглашения Guardian, соответствующие запросу списка.

nextPageToken

string

Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны.

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

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

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

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