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 thesaurus API

The thesaurus API from Hong Kong Baptist University — 5 operation(s) for thesaurus.

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

This API exposes 5 operations across 5 paths, and defines 9 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.

5 operations 5 paths 9 schemas 4 GET1 POST

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 thesaurus 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 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

thesaurus 5
GET
/thesauri
Lists all thesauri
thesaurus_list_1 3 params → 200
GET
/thesauri/allowed-locales
A list of allowed locales in localized strings
thesaurus_getAllowedLocales_1 → 200
GET
/thesauri/orderings
Lists available orderings
thesaurus_getOrderings_1 → 200
POST
/thesauri/search
Query operation for thesauri
thesaurus_query_1 body → 200400
GET
/thesauri/{uuid}
Get thesaurus
thesaurus_get_1 1 param → 200301404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Thesaurus (17 properties), ThesaurusQuery (6 properties), ProblemDetails (5 properties), ThesaurusListResult (3 properties). Each schema is shown below with its type and property counts.

ThesaurusQuery
object
Create a query for thesauri
6 properties
PageInformation
object
Information about pages
2 properties
Thesaurus
object
A thesaurus
17 properties
Identifier
object
1 property 1 required
ThesaurusListResult
object
List of thesauri. Can contain a subset of all items along with the full count
3 properties
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.
OrderingsList
object
List of available orderings
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-thesaurus-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