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

The role API from Hong Kong Baptist University — 2 operation(s) for role.

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

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

2 operations 2 paths 2 schemas 2 GET

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 role 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 2

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

role 2
GET
/roles
Lists all assignable roles
role_get_assignable_roles_1 → 200
GET
/roles/{assignableRoleName}
Returns an assignable role
role_get_assignable_role_1 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is AssignableRole (3 properties). Each schema is shown below with its type and property counts.

LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
AssignableRole
object
An assignable role
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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