Method: userProfiles.guardianInvitations.patch

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

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

Các tham số
studentId

string

Giấy tờ tuỳ thân của học viên cần sửa đổi lời mời là người giám hộ.
invitationId

string

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

Tham số truy vấn

Các tham số
updateMask

string (FieldMask format)

Mặt nạ giúp xác định những trường cần cập nhật trong khoá học. Đâ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 hợp lệ:

  • state

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

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

Đây là danh sách các tên trường đủ điều kiện đượ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.