Hong Kong Baptist University award API
The award API from Hong Kong Baptist University — 36 operation(s) for award.
Hong Kong Baptist University award 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 award. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 42 operations across 36 paths, and defines 72 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.
42 operations
36 paths
72 schemas
1 DELETE31 GET4 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hong Kong Baptist University award 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 42
Across 36 paths, the API surfaces 42 operations — 1 DELETE, 31 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
award 42
GET
/awards
Lists all awards
PUT
/awards
Create award
GET
/awards/allowed-awardholder-roles
A list of allowed award holder roles
GET
/awards/allowed-budget-account-classifications
A list of allowed account classifications
GET
/awards/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/awards/allowed-collaborator-types
A list of allowed collaborator types
GET
/awards/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the award
GET
/awards/allowed-description-types
A list of allowed description types
GET
/awards/allowed-document-licenses
A list of allowed document licenses
GET
/awards/allowed-document-types
A list of allowed document types
GET
/awards/allowed-document-version-types
A list of allowed document version types
GET
/awards/allowed-funding-classifications
A list of allowed funding classifications
GET
/awards/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/awards/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/awards/allowed-link-types
A list of allowed link types
GET
/awards/allowed-locales
A list of allowed locales in localized strings
GET
/awards/allowed-nature-types
A list of allowed nature types
GET
/awards/allowed-templates
A list of allowed award templates
GET
/awards/allowed-types
A list of allowed award types
GET
/awards/allowed-workflow-steps
A list of allowed workflow steps
GET
/awards/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/awards/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/awards/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with awards
PUT
/awards/file-uploads
Upload file to a specific award
GET
/awards/orderings
Lists available orderings
POST
/awards/search
Query operation for awards
GET
/awards/{uuid}
Get award
PUT
/awards/{uuid}
Update award
DELETE
/awards/{uuid}
Delete award
POST
/awards/{uuid}/actions/lock
Lock the content
POST
/awards/{uuid}/actions/unlock
Unlock the content
GET
/awards/{uuid}/budgets
Get the budgets for the award
GET
/awards/{uuid}/budgets/{id}
Get a specific budget for the award
PUT
/awards/{uuid}/budgets/{id}
Update budget for an award
GET
/awards/{uuid}/cluster
Get the award cluster for the award
GET
/awards/{uuid}/dependents
Lists all dependents to an award
GET
/awards/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the award
PUT
/awards/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the award
GET
/awards/{uuid}/files/{fileId}
Get file from the award
GET
/awards/{uuid}/milestones
List award milestones on an award
GET
/awards/{uuid}/notes
Lists notes
PUT
/awards/{uuid}/notes
Create note
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are Award (43 properties), Milestone (30 properties), AwardDocument (18 properties), MilestoneDocument (15 properties). Each schema is shown below with its type and property counts.
AwardDocument
object
An award document.
18 properties
5 required
ApplicationRef
object
A reference to an application
1 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ResearcherCommitment
object
Planned and actual research commitment.
4 properties
1 required
Note
object
A note
3 properties
1 required
MilestoneListResult
object
List of milestones. Can contain a subset of all items along with the full count
3 properties
MilestoneReminder
object
A milestone reminder.
3 properties
2 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
EthicalReviewRef
object
A reference to an ethical review
1 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
ProjectRef
object
A reference to project
1 required
AwardBudget
object
A budget for an award.
3 properties
1 required
ClassificationRefList
object
List of classification references
1 property
Milestone
object
A milestone.
30 properties
2 required
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
DeprecatedSystemCurrencyAmount
object
Deprecated version of SystemCurrencyAmount
2 properties
1 required
DeprecatedDateRange
object
Deprecated version of DateRange
2 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ContentRef
object
2 properties
2 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
AwardFundingBudgetAssociation
object
A budget for a financial funding of an award.
6 properties
1 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property
1 required
PageInformation
object
Information about pages
2 properties
AwardListResult
object
List of awards. Can contain a subset of all items along with the full count
3 properties
AllowedTemplate
object
An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs.
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
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
AccountEntry
object
An account entry of an account.
4 properties
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Visibility
object
Visibility of an object
2 properties
1 required
AwardBudgetResult
object
List of award budgets. Can contain a subset of all items along with the full count
3 properties
AwardClusterRef
object
A reference to an award cluster
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
AwardFundingAssociation
object
Funding associations exists in two variants, financial or non-financial.
8 properties
1 required
AwardCluster
object
An award cluster groups related awards from their individual relations.
14 properties
OrderingsList
object
List of available orderings
1 property
YearlyBudget
object
A yearly budget of an account.
3 properties
Award
object
Awards exists in two variations depending on the functionality enabled in the Pure installation.
43 properties
7 required
AwardsQuery
object
Create a query for awards
6 properties
ProblemDetails
object
RFC7807 Error details
5 properties
AbstractAwardHolderAssociation
object
An association between an award and a person that was awarded it.
9 properties
2 required
AllowedTemplateListResult
object
List of allowed templates.
1 property
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
YearMonth
object
A date that can be defined by only year and month
2 properties
2 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
CollaboratorAssociation
object
A collaborator associated with the content.
4 properties
1 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
SystemCurrencyAmount
object
A monetary value in the Pure installation's system currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurr…
2 properties
1 required
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
ContractRef
object
A reference to a contract
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
MilestoneDocument
object
A milestone document
15 properties
4 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.
DateRange
object
A date range
2 properties
UserRef
object
A reference to an user
1 required
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
ContentRefListResult
object
List of Content Refs
1 property
Account
object
An account of a budget.
9 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 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
Hong Kong Baptist University event API
#award