Method: userProfiles.guardianInvitations.get

Trả về một lời mời dành riêng cho người giám hộ.

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

  • PERMISSION_DENIED nếu 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ộ của học viên do studentId xác định, nếu người giám hộ không được bật 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).
  • NOT_FOUND nếu Lớp học không tìm thấy bản ghi nào của học viên được chỉ định hoặc invitationId. Cũng có thể được trả về nếu học viên tồn tại nhưng người dùng yêu cầu không có quyền xem học viên đó.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Tham số
studentId

string

Giấy tờ tuỳ thân của học viên mà bạn đang yêu cầu gửi lời mời cho người giám hộ.
invitationId

string

Trường id của GuardianInvitation đang được yêu cầu.

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ếu thành công, nội dung phản hồi sẽ chứa một phiên bản của GuardianInvitation.

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.