Method: userProfiles.guardianInvitations.list

Trả về danh sách lời mời của 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 studentId được chỉ định 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ộ đối với 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 người giám hộ không được bật cho miền được đề cập hoặc bị các lỗi truy cập khác.
  • INVALID_ARGUMENT nếu studentId được chỉ định nhưng không thể nhận dạng định dạng của nó (đó không phải là địa chỉ email hoặc studentId từ API hoặc chuỗi giá trị cố định 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à có thể nhận dạng được định dạng của học viên đó, nhưng Lớp học sẽ không có bản ghi nào của 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

Tham số
studentId

string

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

  • giá trị nhận dạng dưới dạng số cho người dùng
  • địa chỉ email của người dùng
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
  • giá trị cố định kiểu chuỗi "-", cho biết rằng 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 dành cho người giám hộ.

Tham số truy vấn

Tham 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 chỉ định, chỉ 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 cần trả về trang kết quả tiếp theo.

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

integer

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

Máy chủ có thể trả về ít kết quả hơn số lượng kết quả đã 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

Phản hồi khi liệt kê lời mời của 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)

Lời mời dành cho người giám hộ khớp với yêu cầu 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, không có thêm kết quả nào.

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.