- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ลองใช้งาน
แก้ไขคำเชิญผู้ปกครอง
ปัจจุบันการแก้ไขที่ถูกต้องเพียงอย่างเดียวคือการเปลี่ยน 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 | 
 รหัสของนักเรียนที่จะแก้ไขคำเชิญผู้ปกครอง | 
| invitationId | 
 ช่อง  | 
พารามิเตอร์การค้นหา
| พารามิเตอร์ | |
|---|---|
| updateMask | 
 หน้ากากที่ระบุฟิลด์ในหลักสูตรที่จะอัปเดต ต้องกรอกข้อมูลในช่องนี้เพื่ออัปเดต การอัปเดตจะดำเนินการไม่สำเร็จหากระบุช่องที่ไม่ถูกต้อง ฟิลด์ต่อไปนี้ใช้ได้ 
 เมื่อตั้งค่าในพารามิเตอร์การค้นหา คุณควรระบุช่องนี้เป็น 
 ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง:  | 
เนื้อความของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ GuardianInvitation
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GuardianInvitation
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
- https://www.googleapis.com/auth/classroom.guardianlinks.students
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์