Method: userProfiles.guardianInvitations.patch

보호자 초대를 수정합니다.

현재 유일하게 유효한 수정사항은 state를 PENDING에서 COMPLETE로 변경하는 것입니다. 이렇게 하면 초대가 취소됩니다.

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

  • PERMISSION_DENIED: 현재 사용자에게 보호자를 관리할 권한이 없거나, 해당 도메인에 보호자가 사용 설정되어 있지 않거나, 기타 액세스 오류가 있는 경우
  • 보호자 링크가 PENDING 상태가 아닌 경우 FAILED_PRECONDITION입니다.
  • 제공된 학생 ID의 형식을 인식할 수 없는 경우 (이메일 주소 또는 이 API의 userId가 아님), 전달된 GuardianInvitation에 COMPLETE 이외의 state가 있거나 state 이외의 필드를 수정하는 경우 INVALID_ARGUMENT입니다.
  • 제공된 학생 ID가 유효한 학생 ID이지만 클래스룸에 해당 학생에 대한 기록이 없거나 id 필드가 클래스룸에 알려진 보호자 초대를 참조하지 않는 경우 NOT_FOUND

HTTP 요청

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

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

경로 매개변수

매개변수
studentId

string

보호자 초대를 수정할 학생의 ID입니다.
invitationId

string

수정할 GuardianInvitation의 id 필드

쿼리 매개변수

매개변수
updateMask

string (FieldMask format)

업데이트할 과정의 필드를 식별하는 마스크입니다. 이 입력란은 업데이트를 수행하는 데 필요합니다. 잘못된 필드를 지정하면 업데이트가 실패합니다. 유효한 필드는 다음과 같습니다.

  • state

쿼리 매개변수에 설정된 경우 이 필드는 다음과 같이 지정해야 합니다.

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

정규화된 필드 이름의 쉼표로 구분된 목록입니다. 예: "user.displayName,photo"

요청 본문

요청 본문에 GuardianInvitation의 인스턴스가 포함됩니다.

응답 본문

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

승인 범위

다음 OAuth 범위가 필요합니다.

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

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