- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Hãy làm thử!
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ếustudentId
đượ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ếustudentId
đượ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ặcstudentId
từ API hoặc chuỗi giá trị cố địnhme
). Cũng có thể được trả về nếu bạn cung cấppageToken
hoặcstate
không hợp lệ.NOT_FOUND
nếu bạn chỉ địnhstudentId
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 |
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:
|
Tham số truy vấn
Tham số | |
---|---|
invitedEmailAddress |
Nếu được chỉ định, chỉ những kết quả có |
states[] |
Nếu chỉ định, chỉ kết quả có giá trị |
pageToken |
Giá trị Nếu không, yêu cầu |
pageSize |
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 ( |
Trường | |
---|---|
guardianInvitations[] |
Lời mời dành cho người giám hộ khớp với yêu cầu danh sách. |
nextPageToken |
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.