How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Bath award API

The award API from University of Bath — 35 operation(s) for award.

University of Bath award API is one of 26 APIs that University of Bath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include award. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 41 operations across 35 paths, and defines 65 schemas. It is described by OpenAPI 3.0.1, at version 5.33.3-3.

Requests are made against a single base URL, /ws/api.

41 operations 35 paths 65 schemas 1 DELETE30 GET4 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.33.3-3
Base URL
https://purehost.bath.ac.uk/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

University of Bath 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 41

Across 35 paths, the API surfaces 41 operations — 1 DELETE, 30 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

award 41
GET
/awards
Lists all awards
award_list 3 params → 200
PUT
/awards
Create award
award_create body → 201400
GET
/awards/allowed-awardholder-roles
A list of allowed award holder roles
award_getAllowedAwardHolderRoles → 200
GET
/awards/allowed-budget-account-classifications
A list of allowed account classifications
award_getAllowedBudgetAccountClassifications → 200
GET
/awards/allowed-classified-identifier-types
A list of allowed classified identifier types
award_getAllowedClassifiedIdentifierTypes → 200
GET
/awards/allowed-collaborator-types
A list of allowed collaborator types
award_getAllowedCollaboratorTypes → 200
GET
/awards/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the award
award_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/awards/allowed-description-types
A list of allowed description types
award_getAllowedDescriptionTypes → 200
GET
/awards/allowed-document-licenses
A list of allowed document licenses
award_getAllowedDocumentLicenses → 200
GET
/awards/allowed-document-types
A list of allowed document types
award_getAllowedDocumentTypes → 200
GET
/awards/allowed-document-version-types
A list of allowed document version types
award_getAllowedDocumentVersionTypes → 200
GET
/awards/allowed-funding-classifications
A list of allowed funding classifications
award_getAllowedFundingClassifications → 200
GET
/awards/allowed-keyword-group-configurations
A list of keyword group configurations
award_getAllowedKeywordGroupConfigurations → 200
GET
/awards/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
award_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/awards/allowed-link-types
A list of allowed link types
award_getAllowedLinkTypes → 200
GET
/awards/allowed-locales
A list of allowed locales in localized strings
award_getAllowedLocales → 200
GET
/awards/allowed-nature-types
A list of allowed nature types
award_getAllowedNatureTypes → 200
GET
/awards/allowed-templates
A list of allowed award templates
award_getAllowedTemplates → 200
GET
/awards/allowed-types
A list of allowed award types
award_getAllowedTypes → 200
GET
/awards/allowed-workflow-steps
A list of allowed workflow steps
award_getAllowedWorkflowSteps → 200
GET
/awards/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
award_getAllowedDisciplineSchemes → 200
GET
/awards/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
award_getAllowedDisciplines 3 params → 200
POST
/awards/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with awards
award_listDisciplineAssociations 1 param body → 200400
PUT
/awards/file-uploads
Upload file to a specific award
award_fileUploads 1 param body → default
GET
/awards/orderings
Lists available orderings
award_getOrderings → 200
POST
/awards/search
Query operation for awards
award_query body → 200400
GET
/awards/{uuid}
Get award
award_get 1 param → 200301404
PUT
/awards/{uuid}
Update award
award_update 1 param body → 200400404409
DELETE
/awards/{uuid}
Delete award
award_delete 1 param → 204404409
POST
/awards/{uuid}/actions/lock
Lock the content
award_lock 1 param → 204404409
POST
/awards/{uuid}/actions/unlock
Unlock the content
award_unlock 1 param → 204404409
GET
/awards/{uuid}/budgets
Get the budgets for the award
award_getBudgets 1 param → 200404
GET
/awards/{uuid}/budgets/{id}
Get a specific budget for the award
award_getBudget 2 params → 200404
PUT
/awards/{uuid}/budgets/{id}
Update budget for an award
award_updateBudget 2 params body → 200400404409
GET
/awards/{uuid}/cluster
Get the award cluster for the award
award_getCluster 1 param → 200404
GET
/awards/{uuid}/dependents
Lists all dependents to an award
award_dependents 2 params → 200
GET
/awards/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the award
award_getDisciplineAssociation 2 params → 200404
PUT
/awards/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the award
award_putDisciplineAssociation 2 params body → 200400404
GET
/awards/{uuid}/files/{fileId}
Get file from the award
award_getFile 2 params → 200
GET
/awards/{uuid}/notes
Lists notes
award_listNotes 3 params → 200404
PUT
/awards/{uuid}/notes
Create note
award_createNote 1 param body → 200400

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are Award (43 properties), AwardDocument (18 properties), AwardCluster (14 properties), AllowedKeywordGroupConfiguration (10 properties). Each schema is shown below with its type and property counts.

DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
Visibility
object
Visibility of an object
2 properties 1 required
ContentRef
object
2 properties 2 required
PageInformation
object
Information about pages
2 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
OrganizationRef
object
A reference to an organization in the institution
1 required
YearMonth
object
A date that can be defined by only year and month
2 properties 2 required
AwardDocument
object
An award document.
18 properties 5 required
ProjectRef
object
A reference to project
1 required
AwardBudget
object
A budget for an award.
3 properties 1 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
Account
object
An account of a budget.
9 properties
DateRange
object
A date range
2 properties
ApplicationRef
object
A reference to an application
1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
AwardRef
object
A reference to an award
1 required
DeprecatedSystemCurrencyAmount
object
Deprecated version of SystemCurrencyAmount
2 properties 1 required
Workflow
object
Information about workflow
2 properties 1 required
DeprecatedDateRange
object
Deprecated version of DateRange
2 properties
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties 1 required
ResearcherCommitment
object
Planned and actual research commitment.
4 properties 1 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
AwardCluster
object
An award cluster groups related awards from their individual relations.
14 properties
KeywordGroup
object
4 properties 2 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
WorkflowListResult
object
List of workflow steps.
1 property
ClassificationRefList
object
List of classification references
1 property
LocalesList
object
List of available locales
1 property
AwardClusterRef
object
A reference to an award cluster
1 required
AwardBudgetResult
object
List of award budgets. Can contain a subset of all items along with the full count
3 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
NoteListResult
object
List of notes
3 properties
AwardListResult
object
List of awards. Can contain a subset of all items along with the full count
3 properties
Note
object
A note
3 properties 1 required
AllowedTemplate
object
An allowed template, such as 'ContributionToJournal' or 'BookAnthology' for research outputs.
2 properties
OrderingsList
object
List of available orderings
1 property
AccountEntry
object
An account entry of an account.
4 properties
AwardFundingBudgetAssociation
object
A budget for a financial funding of an award.
6 properties 1 required
AwardFundingAssociation
object
Funding associations exists in two variants, financial or non-financial.
8 properties 1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
Name
object
A name describing a person, made up of given- and family name
2 properties
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
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
Identifier
object
1 property 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
YearlyBudget
object
A yearly budget of an account.
3 properties
AbstractAwardHolderAssociation
object
An association between an award and a person that was awarded it.
9 properties 2 required
CollaboratorAssociation
object
A collaborator associated with the content.
4 properties 1 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
ContentRefListResult
object
List of Content Refs
1 property
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
AllowedTemplateListResult
object
List of allowed templates.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-bath-award-api-openapi.yml Raw ↑

Other APIs University of Bath publishes across the network.

Research Portal (Pure) OAI-PMH
Research Data Archive OAI-PMH
Research Data Archive REST/Feeds
Library Discovery (Ex Libris Primo)
Azure API Management Developer Portal (non-production)
University of Bath activity API
University of Bath application API
University of Bath authorCollaboration API
University of Bath classificationScheme API
University of Bath dataSet API
University of Bath equipment API
University of Bath event API
Where this information came from

This is an independent, third-party profile of University of Bath award API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.