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

Hong Kong Baptist University semester API

The semester API from Hong Kong Baptist University — 8 operation(s) for semester.

Hong Kong Baptist University semester 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 semester. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 11 operations across 8 paths, and defines 13 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.

11 operations 8 paths 13 schemas 1 DELETE5 GET3 POST2 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
Resource Areas
1

Authentication & Security 1

Hong Kong Baptist University semester 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 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

semester 11
GET
/semesters
Lists all semesters
semester_list_1 3 params → 200
PUT
/semesters
Create semester
semester_create_1 body → 201400409
GET
/semesters/allowed-locales
A list of allowed locales in localized strings
semester_getAllowedLocales_1 → 200
GET
/semesters/orderings
Lists available orderings
semester_getOrderings_1 → 200
POST
/semesters/search
Query operation for semester
semester_query_1 body → 200400
GET
/semesters/{uuid}
Get semester
semester_get_1 1 param → 200301404
PUT
/semesters/{uuid}
Update semester
semester_update_1 1 param body → 200400404
DELETE
/semesters/{uuid}
Delete semester
semester_delete_1 1 param → 204404409
POST
/semesters/{uuid}/actions/lock
Lock the content
semester_lock_1 1 param → 204404409
POST
/semesters/{uuid}/actions/unlock
Unlock the content
semester_unlock_1 1 param → 204404409
GET
/semesters/{uuid}/dependents
Lists all dependents to the semester
semester_dependents_1 2 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Semester (16 properties), ConflictProblemDetails (7 properties), SemesterQuery (6 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

Semester
object
A semester
16 properties 2 required
PageInformation
object
Information about pages
2 properties
Identifier
object
1 property 1 required
ProblemDetails
object
RFC7807 Error details
5 properties
LocalesList
object
List of available locales
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
SemesterQuery
object
Create a query for semester
6 properties
SemesterListResult
object
List of semesters. Can contain a subset of all items along with the full count
3 properties
EducationRef
object
A reference to Education
1 required
ContentRefListResult
object
List of Content Refs
1 property
OrderingsList
object
List of available orderings
1 property
ContentRef
object
2 properties 2 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Hong Kong Baptist University publishes across the network.

HKBU Mobile App Backend (gated)
Hong Kong Baptist University activity API
Hong Kong Baptist University application API
Hong Kong Baptist University authorCollaboration API
Hong Kong Baptist University award API
Hong Kong Baptist University classificationScheme API
Hong Kong Baptist University concept API
Hong Kong Baptist University course API
Hong Kong Baptist University dataSet API
Hong Kong Baptist University education API
Hong Kong Baptist University equipment API
Hong Kong Baptist University ethicalReview API