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 |
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
See: Google Classroom API Reference for classroom.courses.update
.
- type CoursesUpdateResource = "v1" :> ("courses" :> (Capture "id" 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 :> (ReqBody '[JSON] Course :> Put '[JSON] Course)))))))))))
- coursesUpdate :: Course -> Text -> CoursesUpdate
- data CoursesUpdate
- cuXgafv :: Lens' CoursesUpdate (Maybe Text)
- cuUploadProtocol :: Lens' CoursesUpdate (Maybe Text)
- cuPp :: Lens' CoursesUpdate Bool
- cuAccessToken :: Lens' CoursesUpdate (Maybe Text)
- cuUploadType :: Lens' CoursesUpdate (Maybe Text)
- cuPayload :: Lens' CoursesUpdate Course
- cuBearerToken :: Lens' CoursesUpdate (Maybe Text)
- cuId :: Lens' CoursesUpdate Text
- cuCallback :: Lens' CoursesUpdate (Maybe Text)
REST Resource
type CoursesUpdateResource = "v1" :> ("courses" :> (Capture "id" 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 :> (ReqBody '[JSON] Course :> Put '[JSON] Course))))))))))) Source #
A resource alias for classroom.courses.update
method which the
CoursesUpdate
request conforms to.
Creating a Request
:: Course | |
-> Text | |
-> CoursesUpdate |
Creates a value of CoursesUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesUpdate Source #
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
See: coursesUpdate
smart constructor.
Request Lenses
cuUploadProtocol :: Lens' CoursesUpdate (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
cuAccessToken :: Lens' CoursesUpdate (Maybe Text) Source #
OAuth access token.
cuUploadType :: Lens' CoursesUpdate (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
cuBearerToken :: Lens' CoursesUpdate (Maybe Text) Source #
OAuth bearer token.
cuId :: Lens' CoursesUpdate Text Source #
Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
cuCallback :: Lens' CoursesUpdate (Maybe Text) Source #
JSONP