Hong Kong Baptist University person API
The person API from Hong Kong Baptist University — 57 operation(s) for person.
Hong Kong Baptist University person 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 person. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 63 operations across 57 paths, and defines 91 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.
63 operations
57 paths
91 schemas
1 DELETE52 GET4 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University person 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 63
Across 57 paths, the API surfaces 63 operations — 1 DELETE, 52 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
person 63
GET
/persons
Lists all persons
PUT
/persons
Create person
GET
/persons/allowed-academic-qualification-types
A list of allowed academic qualification types for persons
GET
/persons/allowed-academic-qualifications-distinctions
A list of the allowed values for education distinction
GET
/persons/allowed-academic-qualifications-field-of-studies
A list of the allowed values for field of study
GET
/persons/allowed-address-countries
A list of allowed address countries
GET
/persons/allowed-address-subdivisions
A list of allowed subdivisions
GET
/persons/allowed-address-types
A list of allowed address types
GET
/persons/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/persons/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the person
GET
/persons/allowed-document-licenses
A list of allowed document licenses
GET
/persons/allowed-document-types
A list of allowed document types
GET
/persons/allowed-external-positions-appointments
A list of the allowed values for appointments
GET
/persons/allowed-genders
A list of allowed classifications for the gender property
GET
/persons/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/persons/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/persons/allowed-leave-of-absense
A list of allowed classifications for the leave of absence property
GET
/persons/allowed-link-types
A list of allowed link types
GET
/persons/allowed-locales
A list of allowed locales in localized strings
GET
/persons/allowed-main-research-areas
A list of allowed main research areas
GET
/persons/allowed-metric-collections
A list of allowed metric collections
GET
/persons/allowed-names-types
A list of allowed classifications for classified names
GET
/persons/allowed-nationalities
A list of allowed classifications for the nationalities property
GET
/persons/allowed-person-organization-associations-email-types
A list of allowed email types
GET
/persons/allowed-person-organization-associations-employment-types
A list of allowed employment types
GET
/persons/allowed-person-organization-associations-job-titles
A list of allowed job titles
GET
/persons/allowed-person-organization-associations-phonenumber-types
A list of allowed phone number types
GET
/persons/allowed-person-organization-associations-supervisor-roles
A list of allowed supervisor roles
GET
/persons/allowed-person-organization-associations-webaddress-types
A list of allowed web address types
GET
/persons/allowed-private-address-countriesdeprecated
DEPRECATED - use 'allowed-address-countries' - A list of allowed country classifications for private address
GET
/persons/allowed-profile-information-types
A list of allowed classifications for the profile information property
GET
/persons/allowed-profile-photo-types
A list of allowed photo types
GET
/persons/allowed-staff-organization-associations-contract-types
A list of allowed contract types
GET
/persons/allowed-staff-organization-associations-staff-types
A list of allowed staff types
GET
/persons/allowed-student-organization-associations-attendance-status-types
A list of allowed student attendance status types
GET
/persons/allowed-student-organization-associations-country-of-domicile-types
A list of allowed student country of domicile types
GET
/persons/allowed-student-organization-associations-employment-types
A list of allowed employment types
GET
/persons/allowed-student-organization-associations-nationality-types
A list of allowed student nationality types
GET
/persons/allowed-student-organization-associations-type-description-types
A list of allowed student type description types
GET
/persons/allowed-titles-types
A list of allowed classifications for the titles property
GET
/persons/allowed-visiting-scholar-organization-associations-employment-types
A list of allowed employment types
GET
/persons/allowed-workflow-steps
A list of allowed workflow steps
GET
/persons/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/persons/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/persons/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with persons
PUT
/persons/file-uploads
Upload file to a specific person
GET
/persons/orderings
Lists available orderings
POST
/persons/search
Query operation for persons
GET
/persons/{uuid}
Get person
PUT
/persons/{uuid}
Update person
DELETE
/persons/{uuid}
Delete person
POST
/persons/{uuid}/actions/lock
Lock the content
POST
/persons/{uuid}/actions/unlock
Unlock the content
GET
/persons/{uuid}/dependents
Lists all dependents to the person
GET
/persons/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the person
PUT
/persons/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the person
GET
/persons/{uuid}/files/{fileId}
Get file from the person
GET
/persons/{uuid}/highlighted-content
Get highlighted content
PUT
/persons/{uuid}/highlighted-content
Update highlighted content
GET
/persons/{uuid}/metrics/{collection-id}
Lists metrics with collection id
GET
/persons/{uuid}/notes
Lists notes
PUT
/persons/{uuid}/notes
Create note
GET
/persons/{uuid}/supervisee
person supervisees
Schemas 91
The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are Person (51 properties), Document (17 properties), ImageFile (15 properties), HighlightedContent (13 properties). Each schema is shown below with its type and property counts.
ExternalPersonRef
object
A reference to a person external to the institution
1 required
ApplicationRef
object
A reference to an application
1 required
ClassificationRef
object
A reference to a classification value
2 properties
1 required
ProjectRef
object
A reference to project
1 required
CurriculumVitaeRef
object
A reference to a curriculum vitae
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
VisitingScholarOrganizationAssociation
object
A relation describing the association between a visiting scholar and organization
PersonExpertiseRef
object
A reference to a person expertise
1 required
PersonSupervisorAssociation
object
The association data of a person and their supervisor
5 properties
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
ClassifiedAddress
object
A physical address
10 properties
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
MetricCollectionItem
object
A metric collection. Contents a list of metric values.
4 properties
1 required
PersonOrganizationAssociation
object
13 properties
1 required
OrderingsList
object
List of available orderings
1 property
Person
object
An academic professional, student, or other individual attached to the institution.
51 properties
GeoLocation
object
Geographical location
3 properties
ProblemDetails
object
RFC7807 Error details
5 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
PersonListResult
object
List of persons. Can contain a subset of all items along with the full count
3 properties
MetricCollectionDefinition
object
Information about a set of related metrics, usually from a single provider
3 properties
2 required
MetricCollection
object
List of metrics
3 properties
1 required
AcademicQualification
object
An object mapping the data of an education received by a person
11 properties
PersonSuperviseeAssociationListResult
object
A list of supervision associations between persons
3 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
KeywordGroup
object
4 properties
2 required
ClassifiedName
object
A classified name
3 properties
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
HighlightedContent
object
A person's highlighted content
13 properties
PageInformation
object
Information about pages
2 properties
ExternalAppointment
object
An appointment held in an external organizational unit
5 properties
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
Visibility
object
Visibility of an object
2 properties
1 required
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
MetricDefinition
object
Information about how a specific metric is defined; how data of the metric is structured
3 properties
2 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
MetricCollectionDefinitionList
object
List of metric collection definitions
1 property
PersonsQuery
object
Create a query for persons
6 properties
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
AwardRef
object
A reference to an award
1 required
Note
object
A note
3 properties
1 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
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
ImpactRef
object
A reference to impact
1 required
MetricValue
object
A metric value, that contains one piece of data. Only one type of value can be set at a time, and it must match the specification of the metric definition.
6 properties
1 required
InternalOrExternalSupervisor
object
A supervisor, either internal or external, use as mutually exclusive
2 properties
CourseRef
object
A reference to a course
1 required
PersonSuperviseeAssociation
object
Association between a person and their supervisee
5 properties
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
Identifier
object
1 property
1 required
PersonRef
object
A reference to a person internal to the institution
1 required
PressMediaRef
object
A reference to a press/media
1 required
Workflow
object
Information about workflow
2 properties
1 required
DateRange
object
A date range
2 properties
DataSetRef
object
A reference to a data set
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassifiedValue
object
A classified value
3 properties
2 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
EquipmentRef
object
A reference to a piece of equipment
1 required
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.
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
ActivityRef
object
A reference to an activity
1 required
StudentOrganizationAssociation
object
A relation describing the association between student and organization
Document
object
Document
17 properties
4 required
PrizeRef
object
A reference to a prize
1 required
StaffOrganizationAssociation
object
A relation describing the association between Staff and organization
Address
object
A physical address
6 properties
StudentThesisRef
object
A reference to student thesis
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties
1 required
ProfessionalQualification
object
The professional qualifications held by a person
4 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
HonoraryStaffOrganizationAssociation
object
A relation describing the association between honorary staff and organization
ResearchOutputRef
object
A reference to a research output
1 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
PersonClassifiedLeaveOfAbsence
object
Leave of absence held by a person
3 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
WorkflowListResult
object
List of workflow steps.
1 property
CompoundDateRange
object
A date range of that can be defined by only year, year and month or a full date
2 properties
UserRef
object
A reference to an user
1 required
ContentRefListResult
object
List of Content Refs
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hong Kong Baptist University 12
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
#person