| 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.Create
Description
Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
See: Google Classroom API Reference for classroom.invitations.create.
- type InvitationsCreateResource = "v1" :> ("invitations" :> (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 :> (ReqBody `[JSON]` Invitation :> Post `[JSON]` Invitation))))))))))
- invitationsCreate :: Invitation -> InvitationsCreate
- data InvitationsCreate
- icXgafv :: Lens' InvitationsCreate (Maybe Text)
- icUploadProtocol :: Lens' InvitationsCreate (Maybe Text)
- icPp :: Lens' InvitationsCreate Bool
- icAccessToken :: Lens' InvitationsCreate (Maybe Text)
- icUploadType :: Lens' InvitationsCreate (Maybe Text)
- icPayload :: Lens' InvitationsCreate Invitation
- icBearerToken :: Lens' InvitationsCreate (Maybe Text)
- icCallback :: Lens' InvitationsCreate (Maybe Text)
REST Resource
type InvitationsCreateResource = "v1" :> ("invitations" :> (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 :> (ReqBody `[JSON]` Invitation :> Post `[JSON]` Invitation)))))))))) Source
A resource alias for classroom.invitations.create method which the
InvitationsCreate request conforms to.
Creating a Request
Arguments
| :: Invitation | |
| -> InvitationsCreate |
Creates a value of InvitationsCreate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InvitationsCreate Source
Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
See: invitationsCreate smart constructor.
Request Lenses
icUploadProtocol :: Lens' InvitationsCreate (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
icPp :: Lens' InvitationsCreate Bool Source
Pretty-print response.
icAccessToken :: Lens' InvitationsCreate (Maybe Text) Source
OAuth access token.
icUploadType :: Lens' InvitationsCreate (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
icPayload :: Lens' InvitationsCreate Invitation Source
Multipart request metadata.
icBearerToken :: Lens' InvitationsCreate (Maybe Text) Source
OAuth bearer token.
icCallback :: Lens' InvitationsCreate (Maybe Text) Source
JSONP