Hong Kong Baptist University event API

The event API from Hong Kong Baptist University — 21 operation(s) for event.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

26 operations 21 paths 38 schemas 1 DELETE17 GET4 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

Authentication & Security 1

Hong Kong Baptist University event 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 26

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

event 26

GET

/events

Lists all events

event_list 3 params → 200

PUT

/events

Create event

event_create body → 201400

GET

/events/allowed-classified-identifier-types

A list of allowed classified identifier types

event_getAllowedClassifiedIdentifierTypes → 200

GET

/events/allowed-countries

A list of allowed countries

event_getAllowedCountries → 200

GET

/events/allowed-degree-of-recognition

A list of allowed degree of recognitions

event_getAllowedDegreeOfRecognitions → 200

GET

/events/allowed-keyword-group-configurations

A list of keyword group configurations

event_getAllowedKeywordGroupConfigurations → 200

GET

/events/allowed-keyword-group-configurations/{id}/classifications

A list of allowed classifications for the specified keyword group

event_getAllowedKeywordGroupConfigurationClassifications 1 param → 200

GET

/events/allowed-link-types

A list of allowed link types

event_getAllowedLinkTypes → 200

GET

/events/allowed-locales

A list of allowed locales in localized strings

event_getAllowedLocales → 200

GET

/events/allowed-subdivision

A list of allowed subdivisions

event_getAllowedSubdivisions → 200

GET

/events/allowed-types

A list of allowed event types

event_getAllowedTypes → 200

GET

/events/allowed-workflow-steps

A list of allowed workflow steps

event_getAllowedWorkflowSteps → 200

GET

/events/disciplines/allowed-discipline-schemes

A list of allowed discipline schemes

event_getAllowedDisciplineSchemes → 200

GET

/events/disciplines/{discipline-scheme}/allowed-disciplines

A list of allowed disciplines for a specific discipline scheme

event_getAllowedDisciplines 3 params → 200

POST

/events/disciplines/{discipline-scheme}/search

Query operation for disciplines associated with events

event_listDisciplineAssociations 1 param body → 200400

GET

/events/orderings

Lists available orderings

event_getOrderings → 200

POST

/events/search

Query operation for events

events_query body → 200400

GET

/events/{uuid}

Get event

event_get 1 param → 200301404

PUT

/events/{uuid}

Update event

event_update 1 param body → 200400404409

DELETE

/events/{uuid}

Delete event

event_delete 1 param → 204404409

POST

/events/{uuid}/actions/lock

Lock the content

event_lock 1 param → 204404409

POST

/events/{uuid}/actions/unlock

Unlock the content

event_unlock 1 param → 204404409

GET

/events/{uuid}/disciplines/{discipline-scheme}

Get disciplines from the discipline scheme associated with the event

event_getDisciplineAssociation 2 params → 200404

PUT

/events/{uuid}/disciplines/{discipline-scheme}

Update disciplines from the discipline scheme associated with the event

event_putDisciplineAssociation 2 params body → 200400404

GET

/events/{uuid}/notes

Lists notes

event_listNotes 3 params → 200404

PUT

/events/{uuid}/notes

Create note

event_createNote 1 param body → 200400

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Event (31 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties), EventsQuery (6 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

ClassificationRefList

object

List of classification references

1 property

EventListResult

object

List of events. Can contain a subset of all items along with the full count

3 properties

KeywordGroup

object

4 properties 2 required

NoteListResult

object

List of notes

3 properties

OrganizationRef

object

A reference to an organization in the institution

1 required

OrganizationOrExternalOrganizationRef

object

A reference to an organization in the institution or an external organization

2 properties

DisciplinesDiscipline

object

A discipline within a specific discipline scheme

3 properties

FormattedLocalizedString

object

A set of localized strings that support formatting. Invalid locale values will be ignored.

ContentRef

object

2 properties 2 required

ConflictProblemDetails

object

Problem details for state conflict failures

7 properties

ExternalOrganizationRef

object

A reference to an organization external to the institution

1 required

PageInformation

object

Information about pages

2 properties

DisciplinesAssociationsQuery

object

Create a query for discipline associations

3 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

DisciplinesDisciplineSchemeListResult

object

List of discipline schemes

2 properties

EventsQuery

object

Create a query for events

6 properties

OrderingsList

object

List of available orderings

1 property

DisciplinesDisciplineListResult

object

List of disciplines for a specific discipline scheme

3 properties

GeoLocation

object

Geographical location

3 properties

Event

object

An event typically a conference, workshop or similar

31 properties 1 required

ProblemDetails

object

RFC7807 Error details

5 properties

AllowedKeywordGroupConfigurationList

object

List of allowed keyword group configurations

1 property

DisciplinesDisciplineAssignment

object

The assigned discipline and its split percentage

2 properties 2 required

DisciplinesAssociationListResult

object

List of discipline associations. Can contain a subset of all items along with the full count

3 properties

DisciplinesDisciplineScheme

object

A discipline scheme

2 properties 2 required

Identifier

object

1 property 1 required

WorkflowListResult

object

List of workflow steps.

1 property

Workflow

object

Information about workflow

2 properties 1 required

LocalizedString

object

A set of string values, one for each submission locale. Note: invalid locale values will be ignored.

EventRef

object

A reference to an event

1 required

DateRange

object

A date range

2 properties

DisciplinesAssociation

object

An association between a content and a number of discipline assignments

3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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 course 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

#event

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Hong Kong Baptist University event API

Metadata

Authentication & Security 1

Paths & Operations 26

Schemas 38

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Hong Kong Baptist University event API

Metadata

Authentication & Security 1

Paths & Operations 26

Schemas 38

Specification

Source

More from Hong Kong Baptist University 12

API Details

Provider

Explore more