Method: userProfiles.guardianInvitations.get

특정 보호자 초대를 반환합니다.

이 메서드는 다음 오류 코드를 반환합니다.

  • PERMISSION_DENIED: 요청하는 사용자가 studentId에서 확인한 학생의 보호자 초대를 볼 수 없거나, 해당 도메인에 보호자가 사용 설정되어 있지 않거나, 기타 액세스 오류가 있는 경우
  • studentId가 지정되었지만 형식을 인식할 수 없는 경우 (이메일 주소, API의 studentId, 리터럴 문자열 me도 아닌 경우) INVALID_ARGUMENT입니다.
  • 클래스룸에서 특정 학생 또는 invitationId의 기록을 찾을 수 없는 경우 NOT_FOUND입니다. 학생이 있지만 요청하는 사용자에게 해당 학생을 볼 수 있는 액세스 권한이 없는 경우에도 반환될 수 있습니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
studentId

string

보호자 초대를 요청 중인 학생의 ID입니다.
invitationId

string

요청 중인 GuardianInvitation의 id 필드

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 GuardianInvitation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.