Method: userProfiles.guardianInvitations.list

Trả về danh sách lời mời dành cho người giám hộ mà người dùng yêu cầu được phép xem, được lọc theo các tham số được cung cấp.

Phương thức này trả về các mã lỗi sau:

  • PERMISSION_DENIED nếu bạn chỉ định studentId và người dùng yêu cầu không được phép xem lời mời dành cho người giám hộ cho học viên đó, nếu "-" được chỉ định là studentId và người dùng không phải là quản trị viên miền, nếu bạn chưa bật người giám hộ cho miền có liên quan hoặc nếu có lỗi truy cập khác.
  • INVALID_ARGUMENT nếu bạn chỉ định studentId nhưng không nhận dạng được định dạng của studentId (đây không phải là địa chỉ email, studentId từ API hay chuỗi ký tự me). Cũng có thể được trả về nếu bạn cung cấp pageToken hoặc state không hợp lệ.
  • NOT_FOUND nếu bạn chỉ định studentId và định dạng của tệp đó có thể được nhận dạng, nhưng Lớp học không có bản ghi về học viên đó.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
studentId

string

Mã nhận dạng của học viên mà bạn muốn trả về lời mời dành cho người giám hộ. Giá trị nhận dạng có thể là một trong những giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu
  • giá trị cố định chuỗi "-", cho biết kết quả sẽ được trả về cho tất cả học viên mà người dùng yêu cầu được phép xem lời mời của người giám hộ.

Tham số truy vấn

Thông số
invitedEmailAddress

string

Nếu được chỉ định, chỉ những kết quả có invitedEmailAddress đã chỉ định mới được trả về.
states[]

enum (GuardianInvitationState)

Nếu được chỉ định, chỉ những kết quả có giá trị state được chỉ định mới được trả về. Nếu không, kết quả có state là PENDING sẽ được trả về.
pageToken

string

Giá trị nextPageToken được trả về từ lệnh gọi list trước đó, cho biết rằng trang kết quả tiếp theo sẽ được trả về.

Yêu cầu list phải giống hệt với yêu cầu đã tạo ra mã thông báo này.
pageSize

integer

Số lượng mục tối đa cần trả về. Giá trị 0 hoặc không xác định cho biết máy chủ có thể chỉ định giá trị tối đa.

Máy chủ có thể trả về ít hơn số kết quả được chỉ định.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nội dung phản hồi khi liệt kê lời mời dành cho người giám hộ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Trường
guardianInvitations[]

object (GuardianInvitation)

Thư mời dành cho người giám hộ khớp với yêu cầu về danh sách.
nextPageToken

string

Mã thông báo xác định trang kết quả tiếp theo cần trả về. Nếu trống, bạn sẽ không nhận được kết quả nào khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.