Queen's University Belfast prize API
The prize API from Queen's University Belfast — 29 operation(s) for prize.
Queen’s University Belfast prize API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include prize. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 34 operations across 29 paths, and defines 62 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.
Requests are made against a single base URL, https://pure.qub.ac.uk/ws/api.
34 operations
29 paths
62 schemas
1 DELETE24 GET4 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Queen's University Belfast prize 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 34
Across 29 paths, the API surfaces 34 operations — 1 DELETE, 24 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
prize 34
GET
/prizes
Lists all prizes
PUT
/prizes
Create prize
GET
/prizes/allowed-categories
A list of allowed classifications for the category property
GET
/prizes/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/prizes/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the prize
GET
/prizes/allowed-degree-of-recognitions
A list of allowed classifications for the degree of recognition
GET
/prizes/allowed-description-types
A list of allowed classifications for the descriptions property
GET
/prizes/allowed-document-licenses
A list of allowed document licenses
GET
/prizes/allowed-document-types
A list of allowed document types
GET
/prizes/allowed-image-types
A list of allowed image types
GET
/prizes/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/prizes/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/prizes/allowed-link-types
A list of allowed link types
GET
/prizes/allowed-locales
A list of allowed locales in localized strings
GET
/prizes/allowed-receivers-of-prize-roles
A list of allowed receiver of prize roles
GET
/prizes/allowed-types
A list of allowed classifications for the type property
GET
/prizes/allowed-workflow-steps
A list of allowed workflow steps
GET
/prizes/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/prizes/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/prizes/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with prizes
PUT
/prizes/file-uploads
Upload file for a specific prize
GET
/prizes/orderings
Lists available orderings
POST
/prizes/search
Query operation for prizes
GET
/prizes/{uuid}
Get prize
PUT
/prizes/{uuid}
Update prize
DELETE
/prizes/{uuid}
Delete prize
POST
/prizes/{uuid}/actions/lock
Lock the content
POST
/prizes/{uuid}/actions/unlock
Unlock the content
GET
/prizes/{uuid}/dependents
Lists all dependents to a prize
GET
/prizes/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the prize
PUT
/prizes/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the prize
GET
/prizes/{uuid}/files/{fileId}
Get file from the prize
GET
/prizes/{uuid}/notes
Lists notes
PUT
/prizes/{uuid}/notes
Create note
Schemas 62
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Prize (38 properties), Document (17 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
UploadedFile
object
Information about the uploaded file
7 properties
1 required
Document
object
Document
17 properties
4 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
PrizeDataSetAssociation
object
An association to a dataset.
1 property
1 required
PrizeListResult
object
List of prizes. Can contain a subset of all items along with the full count
3 properties
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
StudentThesisRef
object
A reference to student thesis
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
PrizeProjectAssociation
object
An association to a project.
1 property
1 required
Identifier
object
1 property
1 required
DataSetRef
object
A reference to a data set
1 required
Visibility
object
Visibility of an object
2 properties
1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
EquipmentRef
object
A reference to a piece of equipment
1 required
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties
1 required
Note
object
A note
3 properties
1 required
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties
1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationRef
object
A reference to a classification value
2 properties
1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ContentRefListResult
object
List of Content Refs
1 property
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
PrizeActivityAssociation
object
An association to an activity.
1 property
1 required
ContentRef
object
2 properties
2 required
ProjectRef
object
A reference to project
1 required
ProblemDetails
object
RFC7807 Error details
5 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 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
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.
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
ResearchOutputRef
object
A reference to a research output
1 required
PageInformation
object
Information about pages
2 properties
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PrizesQuery
object
Create a query for prizes
6 properties
PrizeRef
object
A reference to a prize
1 required
EventRef
object
A reference to an event
1 required
ClassificationRefList
object
List of classification references
1 property
PrizeStudentThesisAssociation
object
An association to a student thesis.
1 property
1 required
PrizeAssociation
object
An association to a prize.
1 property
1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
WorkflowListResult
object
List of workflow steps.
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
KeywordGroup
object
4 properties
2 required
LocalesList
object
List of available locales
1 property
PrizeEquipmentAssociation
object
An association to a piece of equipment.
1 property
1 required
NoteListResult
object
List of notes
3 properties
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
Workflow
object
Information about workflow
2 properties
1 required
PrizeResearchOutputAssociation
object
An association to a research output.
1 property
1 required
Prize
object
A prize.
38 properties
4 required
OrderingsList
object
List of available orderings
1 property
AbstractPrizeReceiverAssociation
object
An association between prize and a receiver of prize
5 properties
2 required
ActivityRef
object
A reference to an activity
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Queen's University Belfast 12
Other APIs Queen's University Belfast publishes across the network.
Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast dataSet API
Queen's University Belfast education API
#prize