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 |
Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
See: Google Classroom API Reference for classroom.courses.courseWork.delete
.
Synopsis
- type CoursesCourseWorkDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))))
- coursesCourseWorkDelete :: Text -> Text -> CoursesCourseWorkDelete
- data CoursesCourseWorkDelete
- ccwdXgafv :: Lens' CoursesCourseWorkDelete (Maybe Xgafv)
- ccwdUploadProtocol :: Lens' CoursesCourseWorkDelete (Maybe Text)
- ccwdCourseId :: Lens' CoursesCourseWorkDelete Text
- ccwdAccessToken :: Lens' CoursesCourseWorkDelete (Maybe Text)
- ccwdUploadType :: Lens' CoursesCourseWorkDelete (Maybe Text)
- ccwdId :: Lens' CoursesCourseWorkDelete Text
- ccwdCallback :: Lens' CoursesCourseWorkDelete (Maybe Text)
REST Resource
type CoursesCourseWorkDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))) Source #
A resource alias for classroom.courses.courseWork.delete
method which the
CoursesCourseWorkDelete
request conforms to.
Creating a Request
coursesCourseWorkDelete Source #
Creates a value of CoursesCourseWorkDelete
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesCourseWorkDelete Source #
Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
See: coursesCourseWorkDelete
smart constructor.
Instances
Request Lenses
ccwdUploadProtocol :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
ccwdCourseId :: Lens' CoursesCourseWorkDelete Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
ccwdAccessToken :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #
OAuth access token.
ccwdUploadType :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
ccwdId :: Lens' CoursesCourseWorkDelete Text Source #
Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.
ccwdCallback :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #
JSONP