| Copyright | (c) 2015 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 |
Network.Google.Resource.Classroom.Invitations.Accept
Description
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
See: Google Classroom API Reference for classroom.invitations.accept.
- type InvitationsAcceptResource = "v1" :> ("invitations" :> (CaptureMode "id" "accept" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post `[JSON]` Empty))))))))))
- invitationsAccept :: Text -> InvitationsAccept
- data InvitationsAccept
- iaXgafv :: Lens' InvitationsAccept (Maybe Text)
- iaUploadProtocol :: Lens' InvitationsAccept (Maybe Text)
- iaPp :: Lens' InvitationsAccept Bool
- iaAccessToken :: Lens' InvitationsAccept (Maybe Text)
- iaUploadType :: Lens' InvitationsAccept (Maybe Text)
- iaBearerToken :: Lens' InvitationsAccept (Maybe Text)
- iaId :: Lens' InvitationsAccept Text
- iaCallback :: Lens' InvitationsAccept (Maybe Text)
REST Resource
type InvitationsAcceptResource = "v1" :> ("invitations" :> (CaptureMode "id" "accept" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post `[JSON]` Empty)))))))))) Source
A resource alias for classroom.invitations.accept method which the
InvitationsAccept request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> InvitationsAccept |
Creates a value of InvitationsAccept with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InvitationsAccept Source
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
See: invitationsAccept smart constructor.
Request Lenses
iaUploadProtocol :: Lens' InvitationsAccept (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
iaPp :: Lens' InvitationsAccept Bool Source
Pretty-print response.
iaAccessToken :: Lens' InvitationsAccept (Maybe Text) Source
OAuth access token.
iaUploadType :: Lens' InvitationsAccept (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
iaBearerToken :: Lens' InvitationsAccept (Maybe Text) Source
OAuth bearer token.
iaId :: Lens' InvitationsAccept Text Source
Identifier of the invitation to accept.
iaCallback :: Lens' InvitationsAccept (Maybe Text) Source
JSONP