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

The externalPerson API from Hong Kong Baptist University — 22 operation(s) for externalperson.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 27 operations across 22 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.

27 operations 22 paths 38 schemas 1 DELETE17 GET4 POST5 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 externalPerson 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 27

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

externalPerson 27
GET
/external-persons
Lists all external persons
externalPerson_list_1 3 params → 200
PUT
/external-persons
Create external person
externalPerson_create body → 201400
GET
/external-persons/allowed-classified-identifier-types
A list of allowed classified identifier types
externalPerson_getAllowedClassifiedIdentifierTypes_1 → 200
GET
/external-persons/allowed-countries
A list of allowed countries
externalPerson_getAllowedCountries_1 → 200
GET
/external-persons/allowed-image-types
A list of allowed image types
externalPerson_getAllowedImageTypes_1 → 200
GET
/external-persons/allowed-keyword-group-configurations
A list of keyword group configurations
externalPerson_getAllowedKeywordGroupConfigurations_1 → 200
GET
/external-persons/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
externalPerson_getAllowedKeywordGroupConfigurationClassifications_1 1 param → 200
GET
/external-persons/allowed-locales
A list of allowed locales in localized strings
externalPerson_getAllowedLocales_1 → 200
GET
/external-persons/allowed-types
A list of allowed external person types
externalPerson_getAllowedTypes_1 → 200
GET
/external-persons/allowed-workflow-steps
A list of allowed workflow steps
externalPerson_getAllowedWorkflowSteps_1 → 200
GET
/external-persons/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
externalPerson_getAllowedDisciplineSchemes_1 → 200
GET
/external-persons/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
getAllowedDisciplines_1 3 params → 200
POST
/external-persons/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with external persons
externalPerson_listDisciplineAssociations_1 1 param body → 200400
PUT
/external-persons/file-uploads
Upload file to a specific external person
externalPerson_fileUploads_1 1 param body → default
GET
/external-persons/orderings
Lists available orderings
externalPerson_getOrderings_1 → 200
POST
/external-persons/search
Query operation for external persons
externalPerson_query_1 body → 200400
GET
/external-persons/{uuid}
Get external person
externalPerson_get_1 1 param → 200301404
PUT
/external-persons/{uuid}
Update external persons
externalPerson_update_1 1 param body → 200400404409
DELETE
/external-persons/{uuid}
Delete external person
externalPerson_delete_1 1 param → 204404409
POST
/external-persons/{uuid}/actions/lock
Lock the content
externalPerson_lock_1 1 param → 204404409
POST
/external-persons/{uuid}/actions/unlock
Unlock the content
externalPerson_unlock_1 1 param → 204404409
GET
/external-persons/{uuid}/dependents
Lists all dependents to a external person
externalPerson_dependents_1 2 params → 200
GET
/external-persons/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the external person
externalPerson_getDisciplineAssociation_1 2 params → 200404
PUT
/external-persons/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the external person
externalPerson_putDisciplineAssociation_1 2 params body → 200400404
GET
/external-persons/{uuid}/files/{fileId}
Get file from the external person
externalPerson_getFile_1 2 params → 200
GET
/external-persons/{uuid}/notes
Lists notes
externalPerson_listNotes_1 3 params → 200404
PUT
/external-persons/{uuid}/notes
Create note
externalPerson_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 ExternalPerson (22 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties). Each schema is shown below with its type and property counts.

Note
object
A note
3 properties 1 required
ExternalPerson
object
A person not known to the institution
22 properties
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
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
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
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
ExternalPersonListResult
object
List of external persons. Can contain a subset of all items along with the full count
3 properties
UploadedFile
object
Information about the uploaded file
7 properties 1 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
Gender
object
A list of possible genders
2 properties
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
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
ExternalPersonsQuery
object
Create a query for external persons
6 properties
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
Identifier
object
1 property 1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
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.
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
ContentRefListResult
object
List of Content Refs
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-externalperson-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 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
#externalPerson
← Back to H APIs
API Details
ID
hong-kong-baptist-university:hong-kong-baptist-university-externalperson-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