Method: userProfiles.guardianInvitations.get

แสดงคำเชิญผู้ปกครองที่ระบุ

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

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

คำขอ HTTP

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

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

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

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

string

บัตรประจำตัวของนักเรียนที่ได้รับคำขอคำเชิญเป็นผู้ปกครอง
invitationId

string

ฟิลด์ id ของ GuardianInvitation ที่มีการขอ

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

เนื้อหาของคำขอต้องว่างเปล่า

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

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

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

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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