Method: userProfiles.guardians.get

Trả về một người giám hộ cụ thể.

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 thấy người dùng nào khớp với studentId đã cung cấp, nếu người dùng yêu cầu không được phép xem thông tin 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 đối với cá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 người dùng yêu cầu được phép xem người giám hộ của studentId được yêu cầu, nhưng không có bản ghi Guardian nào cho học viên đó khớp với guardianId đã cung cấp.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Thông số
studentId

string

Học viên mà bạn yêu cầu người giám hộ. Một trong số 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
guardianId

string

Trường id từ Guardian.

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 Guardian.

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.me.readonly
  • 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.