POST api/GetProjectKPIData
Request Information
URI Parameters
None.
Body Parameters
KPISearchParams| Name | Description | Type | Additional information |
|---|---|---|---|
| ProjectNO | string |
None. |
|
| FiscalYear | string |
None. |
|
| Month | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ProjectNO": "sample string 1",
"FiscalYear": "sample string 2",
"Month": "sample string 3"
}
application/xml, text/xml
Sample:
<KPISearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.Data.Admin.CustomClasses"> <FiscalYear>sample string 2</FiscalYear> <Month>sample string 3</Month> <ProjectNO>sample string 1</ProjectNO> </KPISearchParams>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ProjectKPIData| Name | Description | Type | Additional information |
|---|---|---|---|
| Owner | string |
None. |
|
| Terminal | string |
None. |
|
| ProgramID | integer |
None. |
|
| Program | string |
None. |
|
| ProjectTitle | string |
None. |
|
| ContractTypeID | integer |
None. |
|
| ContractType | string |
None. |
|
| ArchitectEngineerID | integer |
None. |
|
| ArchitectEngineer | string |
None. |
|
| ContractorID | integer |
None. |
|
| Contractor | string |
None. |
|
| OarLongID | string |
None. |
|
| OarLong | string |
None. |
|
| Scope | string |
None. |
|
| NoticeToProceedContractDate | string |
None. |
|
| NoticeToProceedProjectedDate | string |
None. |
|
| NoticeToProceedCalDays | integer |
None. |
|
| SubstCompContractDate | string |
None. |
|
| SubstCompProjectedDate | string |
None. |
|
| SubstCompCalDays | string |
None. |
|
| FinalCmpContractDate | string |
None. |
|
| FinalCmpProjectedDate | string |
None. |
|
| FinalCmpCalDays | string |
None. |
|
| ContractAmount | string |
None. |
|
| CoAmount | string |
None. |
|
| Total | string |
None. |
|
| PAAmount | string |
None. |
|
| PeriodEndDate | string |
None. |
|
| Status | string |
None. |
|
| StatusCode | string |
None. |
|
| BudgetAmount | decimal number |
None. |
|
| CommittedAmount | decimal number |
None. |
|
| EACAmount | decimal number |
None. |
|
| Attachment | string |
None. |
|
| KPIScheduleLsts | Collection of KPISchedules |
None. |
|
| KPIParticipationLsts | Collection of KPIParticipation |
None. |
|
| FundingLsts | Collection of FundingsList |
None. |
|
| PerformanceLsts | Collection of KPIProgramPerformances |
None. |
|
| MyAttachments | Collection of KPIAttachments |
None. |
Response Formats
application/json, text/json
Sample:
{
"Owner": "sample string 1",
"Terminal": "sample string 2",
"ProgramID": 3,
"Program": "sample string 4",
"ProjectTitle": "sample string 5",
"ContractTypeID": 6,
"ContractType": "sample string 7",
"ArchitectEngineerID": 8,
"ArchitectEngineer": "sample string 9",
"ContractorID": 10,
"Contractor": "sample string 11",
"OarLongID": "sample string 12",
"OarLong": "sample string 13",
"Scope": "sample string 14",
"NoticeToProceedContractDate": "sample string 15",
"NoticeToProceedProjectedDate": "sample string 16",
"NoticeToProceedCalDays": 17,
"SubstCompContractDate": "sample string 18",
"SubstCompProjectedDate": "sample string 19",
"SubstCompCalDays": "sample string 20",
"FinalCmpContractDate": "sample string 21",
"FinalCmpProjectedDate": "sample string 22",
"FinalCmpCalDays": "sample string 23",
"ContractAmount": "sample string 24",
"CoAmount": "sample string 25",
"Total": "sample string 26",
"PAAmount": "sample string 27",
"PeriodEndDate": "sample string 28",
"Status": "sample string 29",
"StatusCode": "sample string 30",
"BudgetAmount": 31.0,
"CommittedAmount": 32.0,
"EACAmount": 33.0,
"Attachment": "sample string 34",
"KPIScheduleLsts": [
{
"ScheduleNotification": "sample string 1",
"ContractDate": "sample string 2",
"ProjectedDate": "sample string 3",
"VarianceInCalendarDays": "sample string 4"
},
{
"ScheduleNotification": "sample string 1",
"ContractDate": "sample string 2",
"ProjectedDate": "sample string 3",
"VarianceInCalendarDays": "sample string 4"
}
],
"KPIParticipationLsts": [
{
"VendorName": "sample string 1",
"Goal": "sample string 2"
},
{
"VendorName": "sample string 1",
"Goal": "sample string 2"
}
],
"FundingLsts": [
{
"Funds": "sample string 1",
"Color": "sample string 2",
"ColorClass": "sample string 3"
},
{
"Funds": "sample string 1",
"Color": "sample string 2",
"ColorClass": "sample string 3"
}
],
"PerformanceLsts": [
{
"Performance": "sample string 1",
"LastMonth": "sample string 2",
"CurrentMonth": "sample string 3"
},
{
"Performance": "sample string 1",
"LastMonth": "sample string 2",
"CurrentMonth": "sample string 3"
}
],
"MyAttachments": [
{
"Id": 1,
"src": "sample string 2"
},
{
"Id": 1,
"src": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<ProjectKPIData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.Data.Admin.CustomClasses">
<ArchitectEngineer>sample string 9</ArchitectEngineer>
<ArchitectEngineerID>8</ArchitectEngineerID>
<Attachment>sample string 34</Attachment>
<BudgetAmount>31</BudgetAmount>
<CoAmount>sample string 25</CoAmount>
<CommittedAmount>32</CommittedAmount>
<ContractAmount>sample string 24</ContractAmount>
<ContractType>sample string 7</ContractType>
<ContractTypeID>6</ContractTypeID>
<Contractor>sample string 11</Contractor>
<ContractorID>10</ContractorID>
<EACAmount>33</EACAmount>
<FinalCmpCalDays>sample string 23</FinalCmpCalDays>
<FinalCmpContractDate>sample string 21</FinalCmpContractDate>
<FinalCmpProjectedDate>sample string 22</FinalCmpProjectedDate>
<FundingLsts>
<FundingsList>
<Color>sample string 2</Color>
<ColorClass>sample string 3</ColorClass>
<Funds>sample string 1</Funds>
</FundingsList>
<FundingsList>
<Color>sample string 2</Color>
<ColorClass>sample string 3</ColorClass>
<Funds>sample string 1</Funds>
</FundingsList>
</FundingLsts>
<KPIParticipationLsts>
<KPIParticipation>
<Goal>sample string 2</Goal>
<VendorName>sample string 1</VendorName>
</KPIParticipation>
<KPIParticipation>
<Goal>sample string 2</Goal>
<VendorName>sample string 1</VendorName>
</KPIParticipation>
</KPIParticipationLsts>
<KPIScheduleLsts>
<KPISchedules>
<ContractDate>sample string 2</ContractDate>
<ProjectedDate>sample string 3</ProjectedDate>
<ScheduleNotification>sample string 1</ScheduleNotification>
<VarianceInCalendarDays>sample string 4</VarianceInCalendarDays>
</KPISchedules>
<KPISchedules>
<ContractDate>sample string 2</ContractDate>
<ProjectedDate>sample string 3</ProjectedDate>
<ScheduleNotification>sample string 1</ScheduleNotification>
<VarianceInCalendarDays>sample string 4</VarianceInCalendarDays>
</KPISchedules>
</KPIScheduleLsts>
<MyAttachments>
<KPIAttachments>
<Id>1</Id>
<src>sample string 2</src>
</KPIAttachments>
<KPIAttachments>
<Id>1</Id>
<src>sample string 2</src>
</KPIAttachments>
</MyAttachments>
<NoticeToProceedCalDays>17</NoticeToProceedCalDays>
<NoticeToProceedContractDate>sample string 15</NoticeToProceedContractDate>
<NoticeToProceedProjectedDate>sample string 16</NoticeToProceedProjectedDate>
<OarLong>sample string 13</OarLong>
<OarLongID>sample string 12</OarLongID>
<Owner>sample string 1</Owner>
<PAAmount>sample string 27</PAAmount>
<PerformanceLsts>
<KPIProgramPerformances>
<CurrentMonth>sample string 3</CurrentMonth>
<LastMonth>sample string 2</LastMonth>
<Performance>sample string 1</Performance>
</KPIProgramPerformances>
<KPIProgramPerformances>
<CurrentMonth>sample string 3</CurrentMonth>
<LastMonth>sample string 2</LastMonth>
<Performance>sample string 1</Performance>
</KPIProgramPerformances>
</PerformanceLsts>
<PeriodEndDate>sample string 28</PeriodEndDate>
<Program>sample string 4</Program>
<ProgramID>3</ProgramID>
<ProjectTitle>sample string 5</ProjectTitle>
<Scope>sample string 14</Scope>
<Status>sample string 29</Status>
<StatusCode>sample string 30</StatusCode>
<SubstCompCalDays>sample string 20</SubstCompCalDays>
<SubstCompContractDate>sample string 18</SubstCompContractDate>
<SubstCompProjectedDate>sample string 19</SubstCompProjectedDate>
<Terminal>sample string 2</Terminal>
<Total>sample string 26</Total>
</ProjectKPIData>