보호자 초대를 수정합니다.
현재 유일하게 유효한 수정은 state
를 PENDING
에서 COMPLETE
로 변경하는 것입니다. 이 경우 초대를 철회할 수 있습니다.
이 메서드는 다음 오류 코드를 반환합니다.
PERMISSION_DENIED
: 현재 사용자에게 보호자 관리 권한이 없거나 해당 도메인 또는 기타 액세스 오류에 보호자가 사용 설정되지 않은 경우FAILED_PRECONDITION
(보호자 링크가PENDING
상태가 아닌 경우)- 제공된 학생 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 |
보호자 초대를 수정할 학생의 ID입니다. |
invitationId |
수정할 |
쿼리 매개변수
매개변수 | |
---|---|
updateMask |
과정에서 업데이트할 필드를 식별하는 마스크입니다. 업데이트하려면 이 필드가 필요합니다. 잘못된 필드가 지정되면 업데이트가 실패합니다. 유효한 필드는 다음과 같습니다.
쿼리 매개변수에 설정할 경우 이 필드는
필드의 정규화된 이름을 쉼표로 구분한 목록입니다. 예: |
요청 본문
요청 본문에는 GuardianInvitation
의 인스턴스가 포함됩니다.
응답 본문
성공한 경우 응답 본문에 GuardianInvitation
의 인스턴스가 포함됩니다.
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/classroom.guardianlinks.students
자세한 내용은 승인 가이드를 참고하세요.