Awards Management API : Create Funding Opportunities
The Awards Management API includes functionality to create new Funding Opportunities by cloning existing opportunities.
Functionality to note:
Some fields can only be populated from the copied Funding Opportunity:
Review workflow
Eligibility form template to be used
Proposal form template to be used
Where Access = Hidden, selected Users / Groups granted access
Internal approval date
Funding Opportunity managing group
Some fields are derived from the values input (e.g. Status is derived from the internal open / close dates)
Classifications are not copied from the cloned opportunity and are not editable via the API
For editable fields (details below):
Where a field is provided, the value from the copied Funding Opportunity will be overridden with the value provided
Where a date or number field is empty or null, this will override the cloned value with a null (only accepted for non-mandatory fields)
Where a string field is an empty string, this will override the cloned value with an empty string (only accepted for non-mandatory fields)
Where a string field null, this will override the cloned value with a null (only accepted for non-mandatory fields)
Boolean fields do not accept empty or null
Where a field is not provided, the value will be sourced from the copied Funding Opportunity
It is only possible to create one Funding Opportunity per API call
Details of the schema are as follows:
Field | Description | Notes |
idToClone | GUID of the existing funding opportunity you wish to clone | Required |
name | Funding opportunity name | Required |
description | Summary description of the funding opportunity | |
eligibilityCriteria | Summary of the opportunity's eligibility criteria | |
organisationID | GUID of the funder organisation | |
funderOpportunityIdentifier | Funder's ID for the opportunity | |
sourceIdentifier | Source ID for the opportunity where sourced from another system | |
information | Additional details about the opportunity | |
funderCurrencyCode | ID of the currency of the award, if different to your base currency | |
funderProgrammeID | GUID of the Funder programme | |
funderSchemeID | GUID of the Funder scheme | |
fundingTypeID | GUID of the Funding type | |
contestableFundingID | GUID of the Contestable funding value | |
matchedFundingID | GUID of the Matched funding value | |
researchFundingID | GUID of the Research funding value | |
isInternalFunding | TRUE / FALSE whether internal funding | Cannot be null / empty |
internalOpenDate | Date on which the opportunity opens for proposals in Elements | Mandatory field - cannot be null / empty |
internalCloseDate | Date on which the opportunity closes and proposals can no longer be submitted in Elements | Mandatory field - cannot be null / empty |
funderOpenDate | Informational date to communicate when the funder will start accepting applications | |
funderCloseDate | Informational date to communicate when the funder will cease accepting applications | |
funderTimezone | Informational timezone to communicate the funder's timezone | |
visibilityID | GUID of the Access value | Mandatory field - cannot be null / empty |
configurationTypeID | GUID of the Configuration type value | Mandatory field - cannot be null / empty |
referenceFormat | Upon proposal submission, the proposal is assigned a new 'Submitted proposal reference' ID; the format of that reference is determined by this field and the nextReference field | Mandatory field - cannot be null / empty |
nextReference | Mandatory field - cannot be null / empty | |
blockMultipleApplications | TRUE / FALSE whether to prevent users from submitting multiple Proposals for the opportunity | Cannot be null / empty |
blockSubmissions | TRUE / FALSE to disable the ability to submit Proposals for the opportunity | Cannot be null / empty |
mainContactID | Support contact GUID, where a Console user | |
contactName | Support contact name, where not a Console user | |
contactPhone | Support contact phone number | |
contactEmail | Support contact email address | |
contactUrl | Support contact URL | |
contactUrlDescription | The name of the URL to be provided to users | |
onScreenConfirmation | On-screen message that can optionally be displayed to the Principal Investigator when they have successfully submitted their proposal | |
emailConfirmation | Message that is merged into the email that Principal Investigators receive when they have successfully submitted their proposal Note that HTML is NOT supported | |
fundingOpportunityDates | You can capture additional dates and descriptions that are key to the timeline of the funding opportunity |