How Can We Help?

Funding Opportunity XMLFunding Opportunity XML

Overview

This page details the Funding Opportunity content type. On this page you will find different representations of the data elements contained within this type.

Below is the xsd for the Funding Opportunity content type that defines the import xml format. Also provided is mapping tables generated based on this XSD as well as an example xml that shows how the fields can be populated.

This is logical broken down into the different elements to help you gain a better understanding of the Funding Opportunity content type and how to create, read and update these records using the mechanisms provided in Pure.

Note: for the mapping tables all attributes and elements are listed, along with descriptions of the purposes of the field and any data requirements. Attribute are prefaced with an "@" to differentiate from elements, but as shown in the examples this isn't used when generating the xml.

Some elements offer options of which elements to include (such as whether to provide the ID of a person or organisation or name for lookup). These are denoted by reference to "Option Groups" where numbers are used to indicate where multiple elements are part of the same option. See example xmls for demonstrations of how to use these elements.

A Funding opportunity in Pure is a record with detailed information about research funding being available
from a funder. This record contains information about the funder, the funding program, eligibility criteria,
deadlines, award ceilings etc.

Below are a series of attachments for your reference:

Simple Example XML - This shows only the mandatory fields that need to be populated
Advanced Example XML - This shows all fields that can be used. Snippets of this file are shown with their related elements below.
XSD (Xml Schema Definition) - This is a definition of what structure the XML must follow. This page has been generated based on the contents of the xsd file, and snippets of the definition are shown with their relevant element below
Editor Example PNG - This image shows the result of loading the advanced example xml into Pure, to allow for easy reference of which fields in Pure point to which elements in the XML. Note that the way the data is presented within your Pure instance may be different due to different configuration
Webservice Example Response - This shows an example response of retrieving the record generated via this xml via the webservice

Download All

Funding Opportunities

fundingOpportunities

A list of fundingOpportunity elements of type fundingOpportunity

XML Example

<fundingOpportunities xmlns="v1.funding-opportunity.pure.atira.dk"
                              xmlns:cmns="v3.commons.pure.atira.dk"><!--
                For each funding opportunity to create in Pure there should be one of these elements.
                Type should be defined in the "Funding opportunity types" classification scheme
            -->
           <fundingOpportunity id="funding1" type="conf" managedInPure="false">
              <title>Title of Funding Opportunity</title>
              <description>Description of the funding opportunity</description>
              <!-- Can provide translations for supported submission languages -->
              <translatedTitles>
                 <title lang="de">Titel</title>
              </translatedTitles>
              <translatedDescriptions>
                 <description lang="de">Beschreibung</description>
              </translatedDescriptions>
              <!-- ID type should be defined in "Types of funding opportunity sources" classification scheme -->
              <ids>
                 <cmns:id type="fundingnumber">123896</cmns:id>
              </ids>
              <url>https://www.fundinginstitutional.com/</url>
              <fundingOrganisations><!-- Can provide just an ID or name and other details and Pure will attempt to match. If match is not found a new record will be created -->
                 <cmns:externalOrganisation>
                    <cmns:name>National Institute of Health (NIH)</cmns:name>
                    <cmns:type>government</cmns:type>
                    <cmns:country>us</cmns:country>
                 </cmns:externalOrganisation>
                 <cmns:externalOrganisation>
                    <cmns:externalOrgId>external_organisation_id_002</cmns:externalOrgId>
                 </cmns:externalOrganisation>
              </fundingOrganisations>
              <!-- YYYY-MM-DD format -->
              <openingDate>2023-01-05</openingDate>
              <deadline>2023-09-01</deadline>
              <letterOfIntentDate>2023-07-07</letterOfIntentDate>
              <!-- true or false -->
              <active>true</active>
              <awardCeiling>1000000</awardCeiling>
              <!-- Should be defined in the "Subset of ISO-4217 currencies" classification scheme -->
              <awardCeilingCurrency>USD</awardCeilingCurrency>
              <estimatedFunding>500000</estimatedFunding>
              <!-- Should be defined in the "Subset of ISO-4217 currencies" classification scheme -->
              <estimatedFundingCurrency>USD</estimatedFundingCurrency>
              <!-- true or false -->
              <limitedSubmission>true</limitedSubmission>
              <numberOfAnnualApplicationsPerHEI>10</numberOfAnnualApplicationsPerHEI>
              <numberOfAwards>50</numberOfAwards>
              <!-- true or false -->
              <openAccessRequirements>true</openAccessRequirements>
              <!-- Should be align with the configurations for Funding Opportunity under Adminsitration -> Keywords -->
              <keywords>
                 <keyword>Free text keyword</keyword>
                 <keyword lang="en" logicalName="cfdaKeywordContainers" key="10.217"/>
              </keywords>
              <!-- Elgibility requirements like gender, age or location -->
              <eligibilities>
                 <eligibility><!-- Type should be defined in "Funding opportunity eligibility types" classification scheme -->
                    <eligibilityType>women</eligibilityType>
                    <!-- RECOMMENDATION or REQUIREMENT -->
                    <eligibilityFulfilmentType>RECOMMENDATION</eligibilityFulfilmentType>
                 </eligibility>
                 <eligibility><!-- Type should be defined in "Funding opportunity eligibility types" classification scheme -->
                    <eligibilityType>nation</eligibilityType>
                    <!-- RECOMMENDATION or REQUIREMENT -->
                    <eligibilityFulfilmentType>REQUIREMENT</eligibilityFulfilmentType>
                 </eligibility>
              </eligibilities>
              <!-- Academic degree requirements for eligibility -->
              <academicEligibilities>
                 <eligibility><!-- Type should be defined in "Funding opportunity academic degree eligibility types" classification scheme -->
                    <eligibilityType>minimum_doctor_degree</eligibilityType>
                    <!-- RECOMMENDATION or REQUIREMENT -->
                    <eligibilityFulfilmentType>REQUIREMENT</eligibilityFulfilmentType>
                 </eligibility>
                 <eligibility><!-- Type should be defined in "Funding opportunity academic degree eligibility types" classification scheme -->
                    <eligibilityType>minimum_master_degree</eligibilityType>
                    <!-- RECOMMENDATION or REQUIREMENT -->
                    <eligibilityFulfilmentType>RECOMMENDATION</eligibilityFulfilmentType>
                 </eligibility>
              </academicEligibilities>
              <!-- Should be defined in "Funding opportunities: Nature of activity types" classification scheme -->
              <natureTypes>
                 <natureType>research</natureType>
                 <natureType>individual_grant</natureType>
              </natureTypes>
              <labels>
                 <cmns:label id="label1">
                    <cmns:text>Example Label</cmns:text>
                 </cmns:label>
                 <cmns:label id="label2">
                    <cmns:text>Another Label</cmns:text>
                 </cmns:label>
              </labels>
              <descriptionOfApplicationProcess>Description of steps involved to apply for the funding. Can include internal institution processes</descriptionOfApplicationProcess>
              <urlToApplicationSite>https://www.nih.gov/</urlToApplicationSite>
              <emailAddressForApplication>nhlbiinfo@nhlbi.nih.gov</emailAddressForApplication>
              <!-- true or false -->
              <recurring>true</recurring>
              <!-- Public, Campus, Restricted or Confidential -->
              <visibility>Public</visibility>
           </fundingOpportunity>
        </fundingOpportunities>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="fundingOpportunities">
           <xs:complexType>
              <xs:sequence>
                 <xs:element ref="fundingOpportunity" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
              <xs:attribute name="resumptionToken" type="xs:string">
                 <xs:annotation>
                    <xs:documentation>
                                To enable resumption tokens, add an URL to the "XML source data location" in the job configuration with "{resumptionToken}" as a placeholder, for instance "https://example.org/data?resumptionToken={resumptionToken}".
                                The endpoint must handle the resumptionToken in the following manner:
                                If an empty resumptionToken is sent, the endpoint must return all data. If a non-empty resumptionToken is sent, the endpoint must return all data that has changed since the time the resumptionToken was sent.
                            </xs:documentation>
                 </xs:annotation>
              </xs:attribute>
           </xs:complexType>
        </xs:element>