Method: userProfiles.guardianInvitations.list

Trả về danh sách các 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 thông số đã 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 các lời mời làm 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 người giám hộ chưa được bật cho miền liên quan hoặc vì các lỗi truy cập khác.
  • INVALID_ARGUMENT nếu studentId được chỉ định nhưng định dạng của nó không nhận dạng được (không phải địa chỉ email, cũng không phải studentId từ API, cũng không phải chuỗi ký tự me). Cũng có thể được trả về nếu pageToken hoặc state không hợp lệ được cung cấp.
  • NOT_FOUND nếu bạn chỉ định studentId và nhận dạng định dạng của học viên đó, nhưng Lớp học không lưu hồ sơ 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

Các tham số
studentId

string

Giấy tờ tuỳ thân của học viên có lời mời sẽ được trả lại 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
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
  • chuỗi ký tự "-", cho biết rằng sẽ trả về kết quả 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

Các 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 được chỉ định, chỉ những kết quả có giá trị state đã chỉ định mới được trả về. Nếu không, các 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 với yêu cầu đã dẫn đến mã thông báo này.
pageSize

integer

Số lượng mục tối đa cần trả lại. 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 kết quả hơn số 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 đăng 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
}
Các trường
guardianInvitations[]

object (GuardianInvitation)

Lời mời gửi cho người giám hộ khớp với yêu cầu đăng 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, sẽ 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.