Method: userProfiles.guardianInvitations.patch

แก้ไขคำเชิญผู้ปกครอง

ปัจจุบันการแก้ไขที่ถูกต้องเพียงอย่างเดียวคือการเปลี่ยน state จาก PENDING เป็น COMPLETE การดำเนินการนี้จะมีผลโดยการถอนคำเชิญ

เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้

  • PERMISSION_DENIEDหากผู้ใช้ปัจจุบันไม่มีสิทธิ์จัดการผู้ปกครอง หากไม่ได้เปิดใช้ผู้ปกครองในโดเมนที่เป็นปัญหาหรือเปิดใช้ข้อผิดพลาดอื่นๆ ในการเข้าถึง
  • FAILED_PRECONDITION หากลิงก์ผู้ปกครองไม่อยู่ในสถานะPENDING
  • INVALID_ARGUMENT หากระบบไม่รู้จักรูปแบบบัตรนักศึกษาที่ระบุ (ไม่ใช่อีเมลหรือ userId จาก API นี้) หรือหาก GuardianInvitation ที่ส่งมี state ที่ไม่ใช่ COMPLETE หรือหากแก้ไขช่องที่ไม่ใช่ state
  • NOT_FOUND หากรหัสนักเรียนที่ระบุเป็นบัตรนักศึกษาที่ถูกต้อง แต่ Classroom ไม่มีบันทึกของนักเรียนรายดังกล่าว หรือหากช่อง id ไม่ได้หมายถึงคำเชิญผู้ปกครองที่ทราบว่าใช้ Classroom

คำขอ HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
studentId

string

รหัสของนักเรียนที่ต้องการแก้ไขคำเชิญผู้ปกครอง
invitationId

string

ฟิลด์ id ของ GuardianInvitation ที่จะแก้ไข

พารามิเตอร์การค้นหา

พารามิเตอร์
updateMask

string (FieldMask format)

มาสก์ที่ระบุว่าต้องอัปเดตช่องใดในหลักสูตร ต้องกรอกช่องนี้เพื่ออัปเดต การอัปเดตจะไม่สำเร็จหากระบุช่องไม่ถูกต้อง ช่องต่อไปนี้ถูกต้อง

  • state

เมื่อตั้งค่าในพารามิเตอร์การค้นหา ช่องนี้ควรระบุเป็น

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

ซึ่งเป็นรายการชื่อฟิลด์ที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ GuardianInvitation

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GuardianInvitation

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์