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

Hong Kong Baptist University fundingOpportunity API

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

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

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

25 operations 21 paths 36 schemas 1 DELETE17 GET3 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
Resource Areas
1

Authentication & Security 1

Hong Kong Baptist University fundingOpportunity 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 25

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

fundingOpportunity 25
GET
/funding-opportunities
Lists all funding opportunities
fundingOpportunity_list_1 3 params → 200
PUT
/funding-opportunities
Create funding opportunity
fundingOpportunity_create_1 body → 201400
GET
/funding-opportunities/allowed-classified-academic-degree-eligibility-types
A list of allowed classified identifier types
fundingOpportunity_getAllowedAcademicDegreeEligibilityTypes_1 → 200
GET
/funding-opportunities/allowed-classified-eligibility-types
A list of allowed classified identifier types
fundingOpportunity_getAllowedEligibilityTypes_1 → 200
GET
/funding-opportunities/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the funding opportunity
fundingOpportunity_getAllowedCustomDefinedFieldClassifications_1 1 param → 200400404
GET
/funding-opportunities/allowed-document-licenses
A list of allowed document licenses
fundingOpportunity_getAllowedDocumentLicenses_1 → 200
GET
/funding-opportunities/allowed-document-types
A list of allowed document types
fundingOpportunity_getAllowedDocumentTypes_1 → 200
GET
/funding-opportunities/allowed-document-version-types
A list of allowed document version types
fundingOpportunity_getAllowedDocumentVersionTypes_1 → 200
GET
/funding-opportunities/allowed-keyword-group-configurations
A list of keyword group configurations
fundingOpportunity_getAllowedKeywordGroupConfigurations_1 → 200
GET
/funding-opportunities/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
fundingOpportunity_getAllowedKeywordGroupConfigurationClassifications_1 1 param → 200
GET
/funding-opportunities/allowed-locales
A list of allowed locales in localized strings
fundingOpportunity_getAllowedLocales_1 → 200
GET
/funding-opportunities/allowed-nature-types
A list of allowed classified identifier types
fundingOpportunity_getAllowedNatureTypes_1 → 200
GET
/funding-opportunities/allowed-types
A list of allowed classifications for the type property
fundingOpportunity_getAllowedTypes_1 → 200
PUT
/funding-opportunities/file-uploads
Upload file to a specific funding opportunity
fundingOpportunity_fileUploads_1 1 param body → default
GET
/funding-opportunities/orderings
Lists available orderings
fundingOpportunity_getOrderings_1 → 200
POST
/funding-opportunities/search
Query operation for funding opportunities
fundingOpportunity_query_1 body → 200400
GET
/funding-opportunities/{uuid}
Get funding opportunity
fundingOpportunity_get_1 1 param → 200301404
PUT
/funding-opportunities/{uuid}
Update funding opportunity
fundingOpportunity_update_1 1 param body → 200400404409
DELETE
/funding-opportunities/{uuid}
Delete funding opportunity
fundingOpportunity_delete_1 1 param → 204404409
POST
/funding-opportunities/{uuid}/actions/lock
Lock the content
fundingOpportunity_lock_1 1 param → 204404409
POST
/funding-opportunities/{uuid}/actions/unlock
Unlock the content
fundingOpportunity_unlock_1 1 param → 204404409
GET
/funding-opportunities/{uuid}/dependents
Lists all dependents to a funding opportunity
fundingOpportunity_dependents_1 2 params → 200
GET
/funding-opportunities/{uuid}/files/{fileId}
Get file from the funding opportunity
fundingOpportunity_getFile_1 2 params → 200
GET
/funding-opportunities/{uuid}/notes
Lists notes
fundingOpportunity_listNotes_1 3 params → 200404
PUT
/funding-opportunities/{uuid}/notes
Create note
fundingOpportunity_createNote_1 1 param body → 200400

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are FundingOpportunity (47 properties), FundingOpportunityDocument (18 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
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
FundingOpportunityDocument
object
Funding Opportunity document
18 properties 5 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
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
CurrencyAmount
object
A monetary value in the specified currency as defined by the W3C's Payment Request standard: https://www.w3.org/TR/payment-request/paymentcurrencyamount-dictio…
2 properties 2 required
PageInformation
object
Information about pages
2 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
UploadedFile
object
Information about the uploaded file
7 properties 1 required
Visibility
object
Visibility of an object
2 properties 1 required
FormattedString
object
A string containing HTML formatted text
1 property 1 required
OrderingsList
object
List of available orderings
1 property
FundingOpportunity
object
Funding opportunities exists in two variations depending on the functionality enabled in the Pure installation.
47 properties 3 required
FundingOpportunityAcademicDegreeEligibility
object
Academic degree eligibility of the funding opportunity
3 properties 2 required
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
FundingOpportunitiesQuery
object
Create a query for funding opportunities
6 properties
FundingOpportunityEligibility
object
Eligibility of the funding opportunity
3 properties 2 required
Label
object
A label that can be attached to an item
3 properties 1 required
FundingOpportunityListResult
object
List of funding opportunities. Can contain a subset of all items along with the full count
3 properties
Identifier
object
1 property 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.
UserRef
object
A reference to an user
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hong-kong-baptist-university-fundingopportunity-api-openapi.yml Raw ↑

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