Method: userProfiles.guardianInvitations.create

Tạo lời mời cho người giám hộ và gửi email cho người giám hộ để yêu cầu họ xác nhận rằng họ là người giám hộ của học viên.

Sau khi người giám hộ chấp nhận lời mời, state của họ sẽ thay đổi thành COMPLETED và họ sẽ bắt đầu nhận được thông báo dành cho người giám hộ. Một tài nguyên Guardian cũng sẽ được tạo để đại diện cho người giám hộ đang hoạt động.

Đối tượng yêu cầu phải đặt trường studentIdinvitedEmailAddress. Nếu không đặt các trường này hoặc đặt bất kỳ trường nào khác trong yêu cầu, bạn sẽ gặp lỗi.

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

  • PERMISSION_DENIED nếu người dùng hiện tại không có quyền quản lý người giám hộ, nếu người giám hộ có liên quan đã từ chối quá nhiều yêu cầu đối với học viên đó, 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.
  • RESOURCE_EXHAUSTED nếu học viên hoặc người giám hộ đã vượt quá giới hạn liên kết với người giám hộ.
  • INVALID_ARGUMENT nếu địa chỉ email của người giám hộ không hợp lệ (ví dụ: nếu địa chỉ email quá dài) hoặc nếu không nhận dạng được định dạng của thẻ sinh viên được cung cấp (đây không phải là địa chỉ email cũng không phải là userId từ API này). Lỗi này cũng sẽ được trả về nếu bạn đặt các trường chỉ có thể đọc hoặc nếu bạn đặt trường state thành một giá trị khác với PENDING.
  • NOT_FOUND nếu mã sinh viên bạn cung cấp là mã sinh viên hợp lệ nhưng Lớp học không có hồ sơ của học viên đó.
  • ALREADY_EXISTS nếu đã có lời mời người giám hộ đang chờ xử lý cho học viên và invitedEmailAddress được cung cấp, hoặc nếu invitedEmailAddress được cung cấp khớp với Tài khoản Google của Guardian hiện có cho người dùng này.

Yêu cầu HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

Tham số đường dẫn

Tham số
guardianInvitation.studentId

string

Giấy tờ tuỳ thân của học viên (ở định dạng chuẩn)

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của GuardianInvitation.

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 thực thể GuardianInvitation mới tạo.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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