- 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 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ỉ địnhstudentId
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ếustudentId
đượ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ảistudentId
từ API, cũng không phải chuỗi ký tựme
). Cũng có thể được trả về nếupageToken
hoặcstate
không hợp lệ được cung cấp.NOT_FOUND
nếu bạn chỉ địnhstudentId
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 |
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:
|
Tham số truy vấn
Các tham số | |
---|---|
invitedEmailAddress |
Nếu được chỉ định, chỉ những kết quả có |
states[] |
Nếu được chỉ định, chỉ những kết quả có giá trị |
pageToken |
Giá trị Yêu cầu |
pageSize |
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 ( |
Các trường | |
---|---|
guardianInvitations[] |
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 |
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.