Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hong Kong Baptist University

Hong Kong Baptist University course API

The course API from Hong Kong Baptist University — 27 operation(s) for course.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hong Kong Baptist University course API is one of 34 APIs that Hong Kong Baptist University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include course. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 31 operations across 27 paths, and defines 39 schemas. It is described by OpenAPI 3.0.1, at version 5.35.0.

Requests are made against a single base URL, https://scholars.hkbu.edu.hk/ws/api.

31 operations 27 paths 39 schemas 1 DELETE23 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.0
Base URL
https://scholars.hkbu.edu.hk/ws/api/
Authentication
API Key
Contact
pure-support@elsevier.com
Resource Areas
1

Authentication & Security 1

Hong Kong Baptist University course API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 31

Across 27 paths, the API surfaces 31 operations — 1 DELETE, 23 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

course 31
GET
/courses
Lists all courses
course_list 3 params → 200
PUT
/courses
Create course
course_create body → 201400
GET
/courses/allowed-classified-identifier-types
A list of allowed classified identifier types
course_getAllowedClassifiedIdentifierTypes → 200
GET
/courses/allowed-course-file-access-types
A list of allowed access types for course files
course_getAllowedCourseFileAccessTypes → 200
GET
/courses/allowed-course-file-license-types
A list of allowed license types for course files
course_getAllowedCourseFileLicenseTypes → 200
GET
/courses/allowed-course-file-types
A list of allowed file types for course files
course_getAllowedCourseFileTypes → 200
GET
/courses/allowed-course-occurrence-lecturer-role-types
A list of allowed role types for course lecturers on a given course occurrence
course_getAllowedCourseOccurrenceLecturerRoleTypes → 200
GET
/courses/allowed-course-occurrence-semester-types
A list of allowed semester types for course occurrences
course_getAllowedCourseOccurrenceSemesterTypes → 200
GET
/courses/allowed-credit-types
A list of allowed credit types
course_getAllowedCreditTypes → 200
GET
/courses/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the course
course_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/courses/allowed-description-types
A list of allowed description types
course_getAllowedDescriptionTypes → 200
GET
/courses/allowed-formats
A list of allowed formats
course_getAllowedFormats → 200
GET
/courses/allowed-image-types
A list of allowed image types
course_getAllowedImageTypes → 200
GET
/courses/allowed-keyword-group-configurations
A list of keyword group configurations
course_getAllowedKeywordGroupConfigurations → 200
GET
/courses/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
course_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/courses/allowed-languages
A list of allowed languages
course_getAllowedLanguages → 200
GET
/courses/allowed-levels
A list of allowed levels
course_getAllowedLevels → 200
GET
/courses/allowed-link-types
A list of allowed link types
course_getAllowedLinkTypes → 200
GET
/courses/allowed-locales
A list of allowed locales in localized strings
course_getAllowedLocales → 200
GET
/courses/allowed-types
A list of allowed course types
course_getAllowedTypes → 200
GET
/courses/allowed-workflow-steps
A list of allowed workflow steps in localized strings
course_getAllowedWorkflowSteps → 200
PUT
/courses/file-uploads
Upload file to a specific course
course_fileUploads 1 param body → default
POST
/courses/search
Query operation for courses
course_query body → 200400
GET
/courses/{uuid}
Get course
course_get 1 param → 200301404
PUT
/courses/{uuid}
Update courses
course_update 1 param body → 200400404409
DELETE
/courses/{uuid}
Delete course
course_delete 1 param → 204404409
POST
/courses/{uuid}/actions/lock
Lock the content
course_lock 1 param → 204404409
POST
/courses/{uuid}/actions/unlock
Unlock the content
course_unlock 1 param → 204404409
GET
/courses/{uuid}/files/{fileId}
Get file from the course
course_getFile 2 params → 200
GET
/courses/{uuid}/notes
Lists notes
course_listNotes 3 params → 200404
PUT
/courses/{uuid}/notes
Create note
course_createNote 1 param body → 200400

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Course (35 properties), ImageFile (15 properties), CourseFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.

Note
object
A note
3 properties 1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
KeywordGroup
object
4 properties 2 required
ClassificationRefList
object
List of classification references
1 property
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ContentRef
object
2 properties 2 required
CoursesQuery
object
Create a query for courses
6 properties
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ImageFile
object
An image file
15 properties 2 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
PageInformation
object
Information about pages
2 properties
LocalesList
object
List of available locales
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
UploadedFile
object
Information about the uploaded file
7 properties 1 required
ClassifiedCourseDevelopedByAssociation
object
A person who developed a given course.
4 properties 1 required
Visibility
object
Visibility of an object
2 properties 1 required
AbstractClassifiedCourseLecturerAssociation
object
An association between a course occurrence and a person who lectures on the course occurrence.
5 properties 2 required
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
CourseListResult
object
List of courses. Can contain a subset of all items along with the full count
3 properties
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties 1 required
Identifier
object
1 property 1 required
PersonRef
object
A reference to a person internal to the institution
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
Course
object
A course.
35 properties 6 required
CourseFile
object
A file related to a course
15 properties 2 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
Workflow
object
Information about workflow
2 properties 1 required
DateRange
object
A date range
2 properties
WorkflowListResult
object
List of workflow steps.
1 property
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
CourseOccurrence
object
An occurrence of a given course.
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-course-api-openapi.yml Raw ↑

Other APIs Hong Kong Baptist University publishes across the network.

HKBU Mobile App Backend (gated)
AE Profile APIs.io
Hong Kong Baptist University activity API
AE Profile APIs.io
Hong Kong Baptist University application API
AE Profile APIs.io
Hong Kong Baptist University authorCollaboration API
AE Profile APIs.io
Hong Kong Baptist University award API
AE Profile APIs.io
Hong Kong Baptist University classificationScheme API
AE Profile APIs.io
Hong Kong Baptist University concept API
AE Profile APIs.io
Hong Kong Baptist University dataSet API
AE Profile APIs.io
Hong Kong Baptist University education API
AE Profile APIs.io
Hong Kong Baptist University equipment API
AE Profile APIs.io
Hong Kong Baptist University ethicalReview API
AE Profile APIs.io
Hong Kong Baptist University event API
AE Profile APIs.io
#course
← Back to H APIs
API Details
ID
hong-kong-baptist-university:hong-kong-baptist-university-course-api
Base URL
https://scholars.hkbu.edu.hk/ws/api/
Docs
https://scholars.hkbu.edu.hk/ws/api/rapidoc.html
Provider
Hong Kong Baptist University
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network