GET api/Dashboard/WDTFBudgetSummary/{appid}/{dt}
Returns the Business current training usage and the remaining balance for a Fiscal Year (FY). It also returns the current monthly usage and the remaining balance for the month requested. The Pre-Obligation data returned is for the BusinessPreObligation record that was used by the application pointed to by appid.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| appid |
Application Id |
integer |
Required |
| dt |
DateTime (mm-dd-yyyy) |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
returns { The following FY properties are based on the Fiscal Year derived from dt "BusinessCurrentFY":28341.50, "BusinessRemainingFY":21658.50, "BusinessCurrentMT":0.00, - the month/year from dt "BusinessRemainingMT":10000.00, "PreObligationPresent": true, "PreObligationInitialAmount: 0.00, - The initial amount "PreObligationRemainingAmount: 0.00, - The total remaining amount "PreObligationCurrentAmountUsed: 0.00, - The total amount used, not including unsubmitted applications "PreObligationCurrentMT: 0.00, - the month/year from dt The following 3 properties are based on the Fiscal Year derived from dt "PreObligationApprovedAmount: 0.00, "PreobligationPaidOrApprovedForPaymentAmount: 0.00. "PreObligationUnderReviewAmount: 0.00 "StatusID":1} status will be -1 if something is wrong.and the values will all be 0.00
DashboardBudgetSummaryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessCurrentFY | decimal number |
None. |
|
| BusinessRemainingFY | decimal number |
None. |
|
| BusinessCurrentMT | decimal number |
None. |
|
| BusinessRemainingMT | decimal number |
None. |
|
| PreObligationPresent | boolean |
None. |
|
| PreObligationInitialAmount | decimal number |
None. |
|
| PreObligationRemainingAmount | decimal number |
None. |
|
| PreObligationCurrentAmountUsed | decimal number |
None. |
|
| PreObligationCurrentMT | decimal number |
None. |
|
| PreObligationApprovedAmount | decimal number |
None. |
|
| PreobligationPaidOrApprovedForPaymentAmount | decimal number |
None. |
|
| PreObligationUnderReviewAmount | decimal number |
None. |
|
| StatusID | integer |
None. |
Response Formats
application/json, text/json
{
"BusinessCurrentFY": 1.0,
"BusinessRemainingFY": 2.0,
"BusinessCurrentMT": 3.0,
"BusinessRemainingMT": 4.0,
"PreObligationPresent": true,
"PreObligationInitialAmount": 6.0,
"PreObligationRemainingAmount": 7.0,
"PreObligationCurrentAmountUsed": 8.0,
"PreObligationCurrentMT": 9.0,
"PreObligationApprovedAmount": 10.0,
"PreobligationPaidOrApprovedForPaymentAmount": 11.0,
"PreObligationUnderReviewAmount": 12.0,
"StatusID": 13
}
text/html
{"BusinessCurrentFY":1.0,"BusinessRemainingFY":2.0,"BusinessCurrentMT":3.0,"BusinessRemainingMT":4.0,"PreObligationPresent":true,"PreObligationInitialAmount":6.0,"PreObligationRemainingAmount":7.0,"PreObligationCurrentAmountUsed":8.0,"PreObligationCurrentMT":9.0,"PreObligationApprovedAmount":10.0,"PreobligationPaidOrApprovedForPaymentAmount":11.0,"PreObligationUnderReviewAmount":12.0,"StatusID":13}
application/xml, text/xml
<DashboardBudgetSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TrainingFundREST._BOL"> <BusinessCurrentFY>1</BusinessCurrentFY> <BusinessCurrentMT>3</BusinessCurrentMT> <BusinessRemainingFY>2</BusinessRemainingFY> <BusinessRemainingMT>4</BusinessRemainingMT> <PreObligationApprovedAmount>10</PreObligationApprovedAmount> <PreObligationCurrentAmountUsed>8</PreObligationCurrentAmountUsed> <PreObligationCurrentMT>9</PreObligationCurrentMT> <PreObligationInitialAmount>6</PreObligationInitialAmount> <PreObligationPresent>true</PreObligationPresent> <PreObligationRemainingAmount>7</PreObligationRemainingAmount> <PreObligationUnderReviewAmount>12</PreObligationUnderReviewAmount> <PreobligationPaidOrApprovedForPaymentAmount>11</PreobligationPaidOrApprovedForPaymentAmount> <StatusID>13</StatusID> </DashboardBudgetSummaryDTO>