Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
See: Google Classroom API Reference for classroom.userProfiles.guardianInvitations.create
.
Synopsis
- type UserProFilesGuardianInvitationsCreateResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GuardianInvitation :> Post '[JSON] GuardianInvitation))))))))))
- userProFilesGuardianInvitationsCreate :: Text -> GuardianInvitation -> UserProFilesGuardianInvitationsCreate
- data UserProFilesGuardianInvitationsCreate
- upfgicStudentId :: Lens' UserProFilesGuardianInvitationsCreate Text
- upfgicXgafv :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Xgafv)
- upfgicUploadProtocol :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)
- upfgicAccessToken :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)
- upfgicUploadType :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)
- upfgicPayload :: Lens' UserProFilesGuardianInvitationsCreate GuardianInvitation
- upfgicCallback :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text)
REST Resource
type UserProFilesGuardianInvitationsCreateResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GuardianInvitation :> Post '[JSON] GuardianInvitation)))))))))) Source #
A resource alias for classroom.userProfiles.guardianInvitations.create
method which the
UserProFilesGuardianInvitationsCreate
request conforms to.
Creating a Request
userProFilesGuardianInvitationsCreate Source #
Creates a value of UserProFilesGuardianInvitationsCreate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UserProFilesGuardianInvitationsCreate Source #
Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.
See: userProFilesGuardianInvitationsCreate
smart constructor.
Instances
Request Lenses
upfgicStudentId :: Lens' UserProFilesGuardianInvitationsCreate Text Source #
ID of the student (in standard format)
upfgicXgafv :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Xgafv) Source #
V1 error format.
upfgicUploadProtocol :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
upfgicAccessToken :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text) Source #
OAuth access token.
upfgicUploadType :: Lens' UserProFilesGuardianInvitationsCreate (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
upfgicPayload :: Lens' UserProFilesGuardianInvitationsCreate GuardianInvitation Source #
Multipart request metadata.