Example Payloads: Award, Award Funding, and Award Project
The example payloads in this topic demonstrate how to create a blank award, create an award using a template, associate an existing project to the award, and add funding for the project. This topic also includes payload examples of updating award funding without projects and updating an award project.
This example payload demonstrates how to create an award, associate an existing project to the award, and add funding for the project. All the fields mentioned in the Create Award payload example are mandatory. You must also add an Award Budget Period when you create an award. Fields such as Organization, Institution, and Organization Credit are automatically derived from Business Unit or Sponsors. Hence, these values are not mentioned in this payload example. You must also have a project created from the Projects work area before using this payload.
The award created in this example has a single internal funding source. The project is associated to both external and internal funding sources. Funding is created for both internal and external funding sources.
.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:createAward xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardServiceV2/types/">
<ns1:awardHeader xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardServiceV2/">
<!-- Create Award Details -->
<ns2:AwardName>Service AWD01</ns2:AwardName>
<ns2:AwardNumber>Service AWD01</ns2:AwardNumber>
<ns2:BusinessUnitName>Vision College</ns2:BusinessUnitName>
<ns2:PrincipalInvestigatorName>John Allens</ns2:PrincipalInvestigatorName>
<ns2:SponsorName>Dept of Health and Human Services (DHHS)</ns2:SponsorName>
<ns2:StartDate>2013-10-01</ns2:StartDate>
<ns2:EndDate>2018-09-30</ns2:EndDate>
<ns2:ContractStatus>Active</ns2:ContractStatus>
<ns2:LetterOfCreditFlag>true</ns2:LetterOfCreditFlag>
<ns2:DocumentNumber>JJMC1</ns2:DocumentNumber>
<!-- Add Award Budget Periods -->
<ns2:AwardBudgetPeriod>
<ns2:BudgetPeriod>BP1</ns2:BudgetPeriod>
<ns2:StartDate>2013-10-01</ns2:StartDate>
<ns2:EndDate>2014-09-30</ns2:EndDate>
</ns2:AwardBudgetPeriod>
<ns2:AwardBudgetPeriod>
<ns2:BudgetPeriod>BP2</ns2:BudgetPeriod>
<ns2:StartDate>2014-10-01</ns2:StartDate>
<ns2:EndDate>2015-09-30</ns2:EndDate>
</ns2:AwardBudgetPeriod>
<ns2:AwardBudgetPeriod>
<ns2:BudgetPeriod>BP3</ns2:BudgetPeriod>
<ns2:StartDate>2015-10-01</ns2:StartDate>
<ns2:EndDate>2016-09-30</ns2:EndDate>
</ns2:AwardBudgetPeriod>
<ns2:AwardBudgetPeriod>
<ns2:BudgetPeriod>BP4</ns2:BudgetPeriod>
<ns2:StartDate>2016-10-01</ns2:StartDate>
<ns2:EndDate>2017-09-30</ns2:EndDate>
</ns2:AwardBudgetPeriod>
<ns2:AwardBudgetPeriod>
<ns2:BudgetPeriod>BP5</ns2:BudgetPeriod>
<ns2:StartDate>2017-10-01</ns2:StartDate>
<ns2:EndDate>2018-09-30</ns2:EndDate>
</ns2:AwardBudgetPeriod>
<!--Adding Internal Funding Source -->
<ns2:AwardFundingSource>
<ns2:FundingSourceNumber>Internal FS</ns2:FundingSourceNumber>
</ns2:AwardFundingSource>
<!--Association of Project to Award with multiple funding sources -->
<ns2:AwardProject>
<ns2:ProjectName>JJ_Service_EXT1</ns2:ProjectName>
<ns2:ProjectNumber>JJ_Service_EXT1</ns2:ProjectNumber>
<ns2:AwardProjectFundingSource>
<ns2:FundingSourceName>Dept of Health and Human Services (DHHS)</ns2:FundingSourceName>
</ns2:AwardProjectFundingSource>
<ns2:AwardProjectFundingSource>
<ns2:FundingSourceNumber>Internal FS</ns2:FundingSourceNumber>
</ns2:AwardProjectFundingSource>
</ns2:AwardProject>
<!--Add Funding to the Projects -->
<ns2:AwardFunding>
<ns2:BudgetPeriod>BP1</ns2:BudgetPeriod>
<ns2:FundingSourceName>Internal FS</ns2:FundingSourceName>
<ns2:DirectFundingAmount>1000</ns2:DirectFundingAmount>
<ns2:FundingIssueDate>2013-01-10</ns2:FundingIssueDate>
<ns2:FundingIssueNumber>Fnd1</ns2:FundingIssueNumber>
<ns2:FundingIssueTypeName>Base</ns2:FundingIssueTypeName>
</ns2:AwardFunding>
<ns2:AwardFunding>
<ns2:BudgetPeriod>BP2</ns2:BudgetPeriod>
<ns2:FundingSourceName>Dept of Health and Human Services (DHHS)</ns2:FundingSourceName>
<ns2:DirectFundingAmount>2000</ns2:DirectFundingAmount>
<ns2:FundingIssueDate>2014-01-10</ns2:FundingIssueDate>
<ns2:FundingIssueNumber>Fnd2</ns2:FundingIssueNumber>
<ns2:FundingIssueTypeName>Base</ns2:FundingIssueTypeName>
</ns2:AwardFunding>
</ns1:awardHeader>
</ns1:createAward>
</soap:Body>
</soap:Envelope>This example payload demonstrates how to create an award using an award template, associate an existing project to the award, and add funding for the project. All the fields mentioned in the Create Award payload example are mandatory, except Award Budget Period, which is optional. Fields such as Organization, Institution, and Organization Credit are automatically derived from Business Unit or Sponsors. Hence, these values are not mentioned in this payload example. You should also have a project created from the Projects work area before using this payload.
The award created in this example has a single internal funding
source. The project is associated to both external and internal funding sources. Funding
is created for both internal and external funding
sources.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:createAward xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardServiceV2/types/">
<ns1:awardHeader xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardServiceV2/">
<!-- Create Award Details -->
<ns2:AwardName>Service AWD02</ns2:AwardName>
<ns2:AwardNumber>Service AWD02</ns2:AwardNumber>
<ns2:BusinessUnitName>Vision College</ns2:BusinessUnitName>
<ns2:StartDate>2011-01-10</ns2:StartDate>
<ns2:EndDate>2017-09-30</ns2:EndDate>
<ns2:SourceTemplateNumber>Fed_Aw_T_VCO</ns2:SourceTemplateNumber>
<ns2:ContractStatus>Active</ns2:ContractStatus>
<ns2:LetterOfCreditFlag>true</ns2:LetterOfCreditFlag>
<ns2:DocumentNumber>JJMC2</ns2:DocumentNumber>
<!-- Adding Internal Funding source -->
<ns2:AwardFundingSource>
<ns2:FundingSourceNumber>Internal FS</ns2:FundingSourceNumber>
</ns2:AwardFundingSource>
<!--Association of Project to Award with multiple funding sources -->
<ns2:AwardProject>
<ns2:ProjectName>JJ_Service_EXT1</ns2:ProjectName>
<ns2:ProjectNumber>JJ_Service_EXT1</ns2:ProjectNumber>
<ns2:AwardProjectFundingSource>
<ns2:FundingSourceName>Dept of Health and Human Services (DHHS)</ns2:FundingSourceName>
</ns2:AwardProjectFundingSource>
<ns2:AwardProjectFundingSource>
<ns2:FundingSourceNumber>Internal FS</ns2:FundingSourceNumber>
</ns2:AwardProjectFundingSource>
</ns2:AwardProject>
<!--Add Funding to the Projects -->
<ns2:AwardFunding>
<ns2:BudgetPeriod>BP1</ns2:BudgetPeriod>
<ns2:FundingSourceName>Internal FS</ns2:FundingSourceName>
<ns2:DirectFundingAmount>1000</ns2:DirectFundingAmount>
<ns2:FundingIssueDate>2013-01-10</ns2:FundingIssueDate>
<ns2:FundingIssueNumber>Fnd1</ns2:FundingIssueNumber>
<ns2:FundingIssueTypeName>Base</ns2:FundingIssueTypeName>
</ns2:AwardFunding>
<ns2:AwardFunding>
<ns2:BudgetPeriod>BP2</ns2:BudgetPeriod>
<ns2:FundingSourceName>Dept of Health and Human Services (DHHS)</ns2:FundingSourceName>
<ns2:DirectFundingAmount>2000</ns2:DirectFundingAmount>
<ns2:FundingIssueDate>2014-01-10</ns2:FundingIssueDate>
<ns2:FundingIssueNumber>Fnd2</ns2:FundingIssueNumber>
<ns2:FundingIssueTypeName>Base</ns2:FundingIssueTypeName>
</ns2:AwardFunding>
</ns1:awardHeader>
</ns1:createAward>
</soap:Body>
</soap:Envelope>This example payload demonstrates how to update award funding
without
projects.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header><fmw-context xmlns="http://xmlns.oracle.com/fmw/context/1.0"/><wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:UsernameToken><wsse:Username>Carlton.Baugh</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Welcome0</wsse:Password></wsse:UsernameToken></wsse:Security></soap:Header>
<soap:Body>
<ns1:updateAwardFunding xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/">
<ns1:awardFundings xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/">
<ns2:AwardFundingId>300100004519589</ns2:AwardFundingId>
<ns2:DirectFundingAmount>100000</ns2:DirectFundingAmount>
<ns2:IndirectFundingAmount>200000</ns2:IndirectFundingAmount>
<ns2:FundingIssueDate>2010-10-10</ns2:FundingIssueDate>
<ns2:FundingIssueDescription>Updated</ns2:FundingIssueDescription>
<ns2:FundingIssueNumber>UPD 1</ns2:FundingIssueNumber>
</ns1:awardFundings>
</ns1:updateAwardFunding>
</soap:Body>
</soap:Envelope>
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsa="http://www.w3.org/2005/08/addressing">
<env:Header>
<wsa:Action>http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService//AwardService/updateAwardFundingResponse</wsa:Action>
<wsa:MessageID>urn:uuid:5f10cfe7-4eea-481e-9093-9ea4c3141271</wsa:MessageID>
</env:Header>
<env:Body>
<ns0:updateAwardFundingResponse
xmlns:ns0="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/">
<ns2:result
xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/"
xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/"
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/"
xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ns1:AwardFundingResult">
<ns1:Value>
<ns1:AwardFundingId>300100004519589</ns1:AwardFundingId>
<ns1:AwardId>300100004520034</ns1:AwardId>
<ns1:AwardName>webServicesTestAward</ns1:AwardName>
<ns1:AwardNumber
xsi:nil="true"/>
<ns1:BudgetPeriodId>300100004519386</ns1:BudgetPeriodId>
<ns1:BudgetPeriod>BP</ns1:BudgetPeriod>
<ns1:FundingSourceId>300100004519381</ns1:FundingSourceId>
<ns1:FundingSourceName>Vision Corporation</ns1:FundingSourceName>
<ns1:DirectFundingAmount>100000</ns1:DirectFundingAmount>
<ns1:IndirectFundingAmount>200000</ns1:IndirectFundingAmount>
<ns1:FundingIssueDate>2010-10-10</ns1:FundingIssueDate>
<ns1:FundingIssueDescription>Updated</ns1:FundingIssueDescription>
<ns1:FundingIssueNumber>UPD 1</ns1:FundingIssueNumber>
<ns1:FundingIssueType>SUPPLEMENT</ns1:FundingIssueType>
<ns1:FundingIssueTypeName>Supplement</ns1:FundingIssueTypeName>
<ns1:ObjectVersionNumber>2</ns1:ObjectVersionNumber>
</ns1:Value>
</ns2:result>
</ns0:updateAwardFundingResponse>
</env:Body>
</env:Envelope>This example payload demonstrates how to update an award
project.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header><fmw-context xmlns="http://xmlns.oracle.com/fmw/context/1.0"/><wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:UsernameToken><wsse:Username>Carlton.Baugh</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Welcome0</wsse:Password></wsse:UsernameToken></wsse:Security></soap:Header>
<soap:Body>
<ns1:updateAwardProject xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/">
<ns1:awardProjects xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/">
<ns2:AwardId>300100004520034</ns2:AwardId>
<ns2:ProjectId>300100002985764</ns2:ProjectId>
<ns2:AwardProjectReference>
<ns2:AwardReferenceId>300100004519422</ns2:AwardReferenceId>
<ns2:ReferenceTypeName>AwardDetails</ns2:ReferenceTypeName>
<ns2:ReferenceValue>1111</ns2:ReferenceValue>
<ns2:ReferenceComment>Updated</ns2:ReferenceComment>
</ns2:AwardProjectReference>
</ns1:awardProjects>
</ns1:updateAwardProject>
</soap:Body>
</soap:Envelope>
<env:Envelope
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsa="http://www.w3.org/2005/08/addressing">
<env:Header>
<wsa:Action>http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService//AwardService/updateAwardProjectResponse</wsa:Action>
<wsa:MessageID>urn:uuid:87f0fea1-4769-4dc1-b8e1-dd68671876f1</wsa:MessageID>
</env:Header>
<env:Body>
<ns0:updateAwardProjectResponse
xmlns:ns0="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/">
<ns2:result
xmlns:ns2="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/types/"
xmlns:ns1="http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/"
xmlns:tns="http://xmlns.oracle.com/adf/svc/errors/"
xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ns1:AwardProjectResult">
<ns1:Value>
<ns1:AwardProjectId>300100004519421</ns1:AwardProjectId>
<ns1:ObjectVersionNumber>1</ns1:ObjectVersionNumber>
<ns1:AwardId>300100004520034</ns1:AwardId>
<ns1:AwardName
xsi:nil="true"/>
<ns1:AwardNumber
xsi:nil="true"/>
<ns1:ProjectId>300100002985764</ns1:ProjectId>
<ns1:ProjectName>Project_Vision_College</ns1:ProjectName>
<ns1:ProjectNumber>Project_Vision_College</ns1:ProjectNumber>
<ns1:BurdenScheduleId
xsi:nil="true"/>
<ns1:BurdenScheduleName
xsi:nil="true"/>
<ns1:BurdenScheduleFixedDate
xsi:nil="true"/>
<ns1:AwardProjectReference>
<ns1:AwardReferenceId>300100004519422</ns1:AwardReferenceId>
<ns1:AwardProjectLinkId>300100004519421</ns1:AwardProjectLinkId>
<ns1:ReferenceTypeId>300100004461047</ns1:ReferenceTypeId>
<ns1:ReferenceTypeName>AwardDetails</ns1:ReferenceTypeName>
<ns1:ReferenceValue>1111</ns1:ReferenceValue>
<ns1:ReferenceComment>Updated</ns1:ReferenceComment>
<ns1:ObjectVersionNumber>3</ns1:ObjectVersionNumber>
<ns1:AwardId>300100004520034</ns1:AwardId>
<ns1:AwardProjectReferenceTranslation>
<ns1:Language>KO</ns1:Language>
<ns1:ObjectVersionNumber>2</ns1:ObjectVersionNumber>
<ns1:ReferenceComment>Updated</ns1:ReferenceComment>
<ns1:SourceLang>US</ns1:SourceLang>
</ns1:AwardProjectReferenceTranslation>
<ns1:AwardProjectReferenceTranslation>
<ns1:Language>US</ns1:Language>
<ns1:ObjectVersionNumber>2</ns1:ObjectVersionNumber>
<ns1:ReferenceComment>Updated</ns1:ReferenceComment>
<ns1:SourceLang>US</ns1:SourceLang>
</ns1:AwardProjectReferenceTranslation>
</ns1:AwardProjectReference>
</ns1:Value>
</ns2:result>
</ns0:updateAwardProjectResponse>
</env:Body>
</env:Envelope>