| 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.Courses.Delete
Description
Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
See: Google Classroom API Reference for classroom.courses.delete.
- type CoursesDeleteResource = "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 :> Delete `[JSON]` Empty))))))))))
- coursesDelete :: Text -> CoursesDelete
- data CoursesDelete
- cdXgafv :: Lens' CoursesDelete (Maybe Text)
- cdUploadProtocol :: Lens' CoursesDelete (Maybe Text)
- cdPp :: Lens' CoursesDelete Bool
- cdAccessToken :: Lens' CoursesDelete (Maybe Text)
- cdUploadType :: Lens' CoursesDelete (Maybe Text)
- cdBearerToken :: Lens' CoursesDelete (Maybe Text)
- cdId :: Lens' CoursesDelete Text
- cdCallback :: Lens' CoursesDelete (Maybe Text)
REST Resource
type CoursesDeleteResource = "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 :> Delete `[JSON]` Empty)))))))))) Source
A resource alias for classroom.courses.delete method which the
CoursesDelete request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> CoursesDelete |
Creates a value of CoursesDelete with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesDelete Source
Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
See: coursesDelete smart constructor.
Request Lenses
cdUploadProtocol :: Lens' CoursesDelete (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
cdPp :: Lens' CoursesDelete Bool Source
Pretty-print response.
cdAccessToken :: Lens' CoursesDelete (Maybe Text) Source
OAuth access token.
cdUploadType :: Lens' CoursesDelete (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
cdBearerToken :: Lens' CoursesDelete (Maybe Text) Source
OAuth bearer token.
cdId :: Lens' CoursesDelete Text Source
Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.
cdCallback :: Lens' CoursesDelete (Maybe Text) Source
JSONP