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 `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.
See: Google Classroom API Reference for classroom.registrations.create
.
Synopsis
- type RegistrationsCreateResource = "v1" :> ("registrations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Registration :> Post '[JSON] Registration))))))))
- registrationsCreate :: Registration -> RegistrationsCreate
- data RegistrationsCreate
- rcXgafv :: Lens' RegistrationsCreate (Maybe Xgafv)
- rcUploadProtocol :: Lens' RegistrationsCreate (Maybe Text)
- rcAccessToken :: Lens' RegistrationsCreate (Maybe Text)
- rcUploadType :: Lens' RegistrationsCreate (Maybe Text)
- rcPayload :: Lens' RegistrationsCreate Registration
- rcCallback :: Lens' RegistrationsCreate (Maybe Text)
REST Resource
type RegistrationsCreateResource = "v1" :> ("registrations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Registration :> Post '[JSON] Registration)))))))) Source #
A resource alias for classroom.registrations.create
method which the
RegistrationsCreate
request conforms to.
Creating a Request
Creates a value of RegistrationsCreate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RegistrationsCreate Source #
Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.
See: registrationsCreate
smart constructor.
Instances
Request Lenses
rcUploadProtocol :: Lens' RegistrationsCreate (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
rcAccessToken :: Lens' RegistrationsCreate (Maybe Text) Source #
OAuth access token.
rcUploadType :: Lens' RegistrationsCreate (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
rcPayload :: Lens' RegistrationsCreate Registration Source #
Multipart request metadata.
rcCallback :: Lens' RegistrationsCreate (Maybe Text) Source #
JSONP