| Copyright | (c) 2015-2025 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <[email protected]> Toni Cebrián <[email protected]> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | GHC2021 |
Gogol.Classroom.Courses.Aliases.Create
Contents
Description
Creates an alias for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors. * NOT_FOUND if the course does not exist. * ALREADY_EXISTS if the alias already exists. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
See: Google Classroom API Reference for classroom.courses.aliases.create.
Synopsis
- type ClassroomCoursesAliasesCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseAlias :> Post '[JSON] CourseAlias))))))))))
- data ClassroomCoursesAliasesCreate = ClassroomCoursesAliasesCreate {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- courseId :: Text
- payload :: CourseAlias
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
- newClassroomCoursesAliasesCreate :: Text -> CourseAlias -> ClassroomCoursesAliasesCreate
Resource
type ClassroomCoursesAliasesCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseAlias :> Post '[JSON] CourseAlias)))))))))) Source #
A resource alias for classroom.courses.aliases.create method which the
ClassroomCoursesAliasesCreate request conforms to.
Constructing a Request
data ClassroomCoursesAliasesCreate Source #
Creates an alias for a course. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to create the alias or for access errors. * NOT_FOUND if the course does not exist. * ALREADY_EXISTS if the alias already exists. * FAILED_PRECONDITION if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
See: newClassroomCoursesAliasesCreate smart constructor.
Constructors
| ClassroomCoursesAliasesCreate | |
Fields
| |
Instances
newClassroomCoursesAliasesCreate Source #
Arguments
| :: Text | Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. See |
| -> CourseAlias | Multipart request metadata. See |
| -> ClassroomCoursesAliasesCreate |
Creates a value of ClassroomCoursesAliasesCreate with the minimum fields required to make a request.