Method: userProfiles.guardianInvitations.patch

Sửa đổi lời mời dành cho người giám hộ.

Hiện tại, nội dung sửa đổi hợp lệ duy nhất là thay đổi state từ PENDING thành COMPLETE. Thao tác này sẽ có hiệu lực rút lại lời mờ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ộ không được bật cho miền có liên quan hoặc nếu có lỗi truy cập khác.
  • FAILED_PRECONDITION nếu đường liên kết của người giám hộ không ở trạng thái PENDING.
  • INVALID_ARGUMENT nếu không thể nhận dạng định dạng của thẻ sinh viên được cung cấp (định dạng này không phải là địa chỉ email, cũng không phải là userId từ API này) hoặc nếu GuardianInvitation đã truyền có state khác với COMPLETE hoặc nếu GuardianInvitation sửa đổi các trường khác với state.
  • NOT_FOUND nếu mã học viên được cung cấp là mã học viên hợp lệ nhưng Lớp học không có hồ sơ về học viên đó hoặc nếu trường id không đề cập đến lời mời của người giám hộ mà Lớp học biết.

Yêu cầu HTTP

PATCH 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 muốn sửa đổi lời mời dành cho người giám hộ.
invitationId

string

Trường id của GuardianInvitation cần được sửa đổi.

Tham số truy vấn

Tham số
updateMask

string (FieldMask format)

Mặt nạ xác định những trường trên khoá học cần cập nhật. Đây là trường bắt buộc để cập nhật. Quá trình cập nhật sẽ không thành công nếu bạn chỉ định các trường không hợp lệ. Các trường sau đây là hợp lệ:

  • state

Khi được đặt trong tham số truy vấn, trường này phải được chỉ định là

updateMask=<field1>,<field2>,...

Đây là danh sách tên đủ điều kiện của các trường được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

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 phiên bản của GuardianInvitation.

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.