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 |
Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
See: Google Classroom API Reference for classroom.courses.aliases.list
.
- type CoursesAliasesListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseAliasesResponse)))))))))))))
- coursesAliasesList :: Text -> CoursesAliasesList
- data CoursesAliasesList
- calXgafv :: Lens' CoursesAliasesList (Maybe Text)
- calUploadProtocol :: Lens' CoursesAliasesList (Maybe Text)
- calPp :: Lens' CoursesAliasesList Bool
- calCourseId :: Lens' CoursesAliasesList Text
- calAccessToken :: Lens' CoursesAliasesList (Maybe Text)
- calUploadType :: Lens' CoursesAliasesList (Maybe Text)
- calBearerToken :: Lens' CoursesAliasesList (Maybe Text)
- calPageToken :: Lens' CoursesAliasesList (Maybe Text)
- calPageSize :: Lens' CoursesAliasesList (Maybe Int32)
- calCallback :: Lens' CoursesAliasesList (Maybe Text)
REST Resource
type CoursesAliasesListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseAliasesResponse))))))))))))) Source #
A resource alias for classroom.courses.aliases.list
method which the
CoursesAliasesList
request conforms to.
Creating a Request
Creates a value of CoursesAliasesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesAliasesList Source #
Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
See: coursesAliasesList
smart constructor.
Request Lenses
calUploadProtocol :: Lens' CoursesAliasesList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
calCourseId :: Lens' CoursesAliasesList Text Source #
The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
calAccessToken :: Lens' CoursesAliasesList (Maybe Text) Source #
OAuth access token.
calUploadType :: Lens' CoursesAliasesList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
calBearerToken :: Lens' CoursesAliasesList (Maybe Text) Source #
OAuth bearer token.
calPageToken :: Lens' CoursesAliasesList (Maybe Text) Source #
nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
calPageSize :: Lens' CoursesAliasesList (Maybe Int32) Source #
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
calCallback :: Lens' CoursesAliasesList (Maybe Text) Source #
JSONP