getWorkset : input parms: Scenario Key, Workset Key; output: success/fail
populateWorksetCache : input parms: Scenario Key, Workset Key, output: success/fail
deleteWorksetCache : input parms: Scenario, output: success/fail
addExpenseLine : POST, input parms, scenarioKey, worksetKey, GLCat, Name (default:GlCat), startDate, endDate, rollsOff [Y|N], amortize [Y|N],[Cokey:Val, CoKey2:val2....], returns speculationId (expense line key)
upDateExpenseLine : PUT, input parms, speculationId,scenarioKey, worksetKey, GLCat, Name (default:GlCat), startDate, endDate, rollsOff [Y|N], amortize [Y|N],[Cokey:Val, CoKey2:val2....],, returns status
deleteExpenseLine : DELETE, speculationId, returns status
getExpenseLines : GET, input parms: Scenario, Budget, Workset, GL category, startDate,endDate, output: array of expense line
Call: (TBD)
rest/v2/newEndpointTBD/forecast_id/glcategory/glcategory_id/speculation?startDate=date3&endDate=date
Sample: (TBD)
rest/v2/newEndpointTBD/KDOODYSHAREDCOSTOBJECTC1443501001FORECAST-324790329-004/glcategory/CRAFT-2/speculation?startDate=07%2F01%2F2013&endDate=06%2F30%2F2014
Response:
getExpenseLines - Response JSON
commitWorksetForecast : input parms: scenarioKey, worksetKey, scenarioName, scenarioDescription) returns status
createForecast (meta) (Not needed for May)
updateForecast (meta) (Not needed for May)
deleteForecast (meta) (Not needed for May)
getExpenseSummary : input parms: Scenario, Budget, Workset, startDate, endDate, output: array of summary lines for All Expenses tab, 1 line per GL Cat
Call:
Sample:
Response:
getExpenseSummary - Response JSON (This needs review)
getExpenseSubtotal : input parms: Scenario, Budget, Workset, GL category, startDate (optional, defaults to workset start Date), endDate (optional, defaults to workset end date), output: array of subtotals, Auth total line only appears when dates are workset begin and end date (because calculated total is based on Auth total minus subtotal lines = calc total )
getExpenseBalance : input parms: Scenario, Budget, Workset, GL category, startDate (optional, defaults to workset start Date), endDate (optional, defaults to workset end date), output: one map of balances
People Calls
getPeopleLines, GET, input parms: Scenario Key, TimeFrame(months, semesters, fiscal years), StartTimeUnit
getPeopleSummary, GET, input parms: Scenario Key, TimeFrame(months, semesters, fiscal years), StartTimeUnit
getPeopleBalances, GET, input parms: Scenario Key, TimeFrame(months, semesters, fiscal years), StartTimeUnit
getPeopleTimeFrames, GET, input parms: none or TimeFrame(months, semesters, fiscal years)
addPerson, POST, input parms:
updatePerson, PUT, input parms:
deletePerson, DELETE, input parms: Scenio Key, personnel key or TBH key