Hong Kong Baptist University organization API
The organization API from Hong Kong Baptist University — 33 operation(s) for organization.
Hong Kong Baptist University organization 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 organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 38 operations across 33 paths, and defines 45 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.
38 operations
33 paths
45 schemas
1 DELETE28 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University organization 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 38
Across 33 paths, the API surfaces 38 operations — 1 DELETE, 28 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
organization 38
GET
/organizations
Lists all organizations
PUT
/organizations
Create organization
GET
/organizations/allowed-address-countries
A list of allowed address countries
GET
/organizations/allowed-address-subdivision
A list of allowed address subdivisions
GET
/organizations/allowed-address-types
A list of allowed address types
GET
/organizations/allowed-classified-file-typesdeprecated
DEPRECATED - use 'allowed-photo-types' - A list of allowed classified identifier types
GET
/organizations/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/organizations/allowed-cost-centers
A list of allowed cost centers
GET
/organizations/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the organization
GET
/organizations/allowed-email-types
A list of allowed e-mail types
GET
/organizations/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/organizations/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/organizations/allowed-link-types
A list of allowed link types
GET
/organizations/allowed-locales
A list of allowed locales in localized strings
GET
/organizations/allowed-main-research-areas
A list of allowed main research areas
GET
/organizations/allowed-name-variant-types
A list of allowed name variant types
GET
/organizations/allowed-phone-number-types
A list of allowed phone number types
GET
/organizations/allowed-photo-types
A list of allowed photo types
GET
/organizations/allowed-profile-information-types
A list of allowed profile information types
GET
/organizations/allowed-types
A list of allowed organization types
GET
/organizations/allowed-web-address-types
A list of allowed web address types
GET
/organizations/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/organizations/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/organizations/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with organizations
PUT
/organizations/file-uploads
Upload file to a specific organization
GET
/organizations/orderings
Lists available orderings
POST
/organizations/search
Query operation for organizations
GET
/organizations/{uuid}
Get organization
PUT
/organizations/{uuid}
Update organization
DELETE
/organizations/{uuid}
Delete organization
POST
/organizations/{uuid}/actions/lock
Lock the content
POST
/organizations/{uuid}/actions/unlock
Unlock the content
GET
/organizations/{uuid}/dependents
Lists all dependents to the organization
GET
/organizations/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the organization
PUT
/organizations/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the organization
GET
/organizations/{uuid}/files/{fileId}
Get file from the organization
GET
/organizations/{uuid}/notes
Lists notes
PUT
/organizations/{uuid}/notes
Create note
Schemas 45
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Organization (31 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties), ClassifiedAddress (10 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.
ClassifiedValue
object
A classified value
3 properties
2 required
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
OrganizationRef
object
A reference to an organization in the institution
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.
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
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
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
ClassifiedAddress
object
A physical address
10 properties
1 required
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
OrderingsList
object
List of available orderings
1 property
ClassifiedLocalizedValue
object
A classified localized value
3 properties
1 required
GeoLocation
object
Geographical location
3 properties
ProblemDetails
object
RFC7807 Error details
5 properties
Organization
object
An organization in the institution
31 properties
3 required
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
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
Identifier
object
1 property
1 required
PersonRef
object
A reference to a person internal to the institution
1 required
ContentRefListResult
object
List of Content Refs
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
DateRange
object
A date range
2 properties
OrganizationsQuery
object
Create a query for organizations
6 properties
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
OrganizationListResult
object
A list of organizations
3 properties
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
#organization