Awards Management API

The Awards Management module offers a further ‘Awards Management API’ in addition to the standard Elements API. This is limited in scope to data associated with the core Awards Management module, and is designed primarily to support:

• Harvesting of Awards Management data by other systems

• Importing/feeding of organisation and/or Funding Opportunity data into the Awards Management module.

These separate APIs can be characterised as follows:

• The Elements API…

  • Provides access to objects across all of Elements, including Awards Management objects

  • Provides read-only access to Awards Management objects

  • Uses an XML data structure.

• The RFS API…

  • Provides access only to Awards Management objects

  • Supports updates to Awards Management organisation objects

  • Uses a JSON data structure.

Data can be harvested from both the Elements API or the Awards Management API, or from the Elements Reporting database (which, for Awards Management users, also includes Awards Management objects). A discussion of this, referencing the Elements API, can be found in Should I use the API or the reporting database?.

If data is to be harvested from an API, in general it is suggested that the Elements API is used, as this provides a consistent set of data covering all of Elements, including Awards Management. However, on occasions there may be more detail available in the Awards Management API than in the Elements API. 

The Awards Management API must be used to import/feed Awards Management objects - this is not supported for Awards Management objects by the Elements API.  

A Contact may be associated with one or more external identifiers, and single Contact record may be fetched using either the internal Contact identifier or any of the external identifiers. An OData endpoint supports some limited OData Query functionality for searching, and there is also an endpoint that will return all Contacts that have been updated after a particular point in time.

The Organisations endpoint provides support for creating, updating and deleting Organisations within Awards Management. An Organisation may be associated with one or more external identifiers, and single Organisation record may be fetched using either the internal Organisation identifier or any of the external identifiers. An OData endpoint supports some limited OData Query functionality for searching, and there is also an endpoint that will return all Organisations that have been updated after a particular point in time.

The Funding Opportunities endpoint provides support for searching and returning all current Funding Opportunities from Awards Management. An OData endpoint supports some limited OData Query functionality for searching, and there is also an endpoint that will return all Funding Opportunities that have been updated after a particular point in time.  A Eligibility form data endpoint returns all associated Eligibility forms (relies upon Reporting IDs being set on Eligibility form controls).  The Funding Opportunities endpoint also provides support for creating new opportunities within Awards Management by cloning existing opportunities; further details are available here.

The Funding Records endpoint provides support for searching and returning all current Funding Records from the Awards Management module. An OData endpoint supports some limited OData Query functionality for searching, and there is also an endpoint that will return all Funding Records that have been updated after a particular point in time. Additionally:

• A Document endpoint allows all Funding Records Documents to be returned, as well as an endpoint that will allow the Document to be downloaded

• A Snapshots endpoint returns a record of a Funding Record at a specific stage in its lifecycle  

• A Deliverables endpoint returns all associated Deliverables

• A Change request endpoint returns all associated Change requests 

• A Budgets endpoint returns all current Budget data for the Funding Record

• A Journals endpoint returns all associated Journal entries

The Budgets endpoint provides support for searching and returning all Budget data from Awards Management.  An OData endpoint supports some limited OData Query functionality for searching.

The Change request endpoint provides support for searching and returning all Change requests from Awards Management.  An OData endpoint supports some limited OData Query functionality for searching.

The Deliverables endpoint provides support for searching and returning all Deliverables from Awards Management.  An OData endpoint supports some limited OData Query functionality for searching.

The Reviews endpoint provides support for searching and returning all current Reviews from Awards Management. An OData endpoint supports some limited OData Query functionality for searching, and there is also an endpoint that will return all Reviews that have been updated after a particular point in time.

The Eligibility form data endpoint provides support for searching and returning Eligibility form data from Awards Management (relies upon Reporting IDs being set on Eligibility form controls).  An OData endpoint supports some limited OData Query functionality for searching.

The Journal endpoint provides support for searching and returning Journal data from Awards Management.  An OData endpoint supports some limited OData Query functionality for searching.

The API uses OpenAPI version 3 and provides a swagger interface for testing and discovery, this can be found at https://{your awards management domain}/GrantTracker/apicore/swagger/index.html.

Guidance on how to access the Awards Management API and making requests to the API is available here.