Versions Compared

Old Version 6

changes.mady.by.user Unknown User (kdoody@mit.edu)

Saved on

compared with

New Version Current

changes.mady.by.user Eugene Bubis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
/rest/v2/workset/:workset_id/header
  • GET: getWorksetCOHeader
/rest/v2/pi/summary
  • GET: getWorksetScenario: input parms: piKey (opt), returns default workset and and forecast keys for a PI
/rest/v2/pi/forecast/cache
  • GET: checkWorksetCache
  • PUT: populateWorksetCache: input parms: scenarioKey, worksetKey, output: success/fail
  • DELETE: deleteWorksetCache: input parms: scenarioKey, output: success/fail
/rest/v2/pi/forecast/period
  • GET: getBiCalendar
/rest/v2/pi/forecast/:forecast_id/balance
  • GET: getBalance/getBalOne: input parms: worksetKey (req), costObjectKey (opt) if costObjectKey is provided, then the call returns balances for a single costobject ONLY
/rest/v2/pi/forecast/:forecast_id/glcategory/:glcategory_id/lineitem/:lineitem_id
  • GET: getWorksetPeopleLines | getWorksetExpenseLines | getWorksetExpenseSumm: lineitem_id is omitted | input parms: worksetKey (req), granularity (req if glcategory_id == 'CRAFT-1' --> M = Monthly, S = Semester, FY = Fiscal Year, AY = Academic Year, Y = Calendar Year, CY = Current Year), startDate (opt), endDate (opt), output: array of expense line, NOTE: glcategory_id == 'CRAFT-0' gives 'all expenses' summary; glcategory_id == 'CRAFT-1' gives people line items
  • POST: (update) expenses (:glcategory_id != 'CRAFT1') - updateExpenseWrk: input parms: worksetKey, costObjectKey, lineItemName, description, startDate, endDate, isRollOff [Y|N], amount, isAmortized [Y|N]
                              people (:glcategory_id == 'CRAFT1') - updatePeopleWrk: input parms: costObjectKey, personnelKey, hrPositionKey, glAccountKey, appointmentKey, granularity, allocation, period
  • PUT: (create expense) updateExpenseWrkColl: lineitem_id is omitted | input parms: worksetKey (req), costObjectCollection (req), lineItemName (req), description (req), startDate (req), endDate (req), isRollOff [Y|N] (req), isAmortized [Y|N] (req)
    costObjectCollection must be a json array in the following format:

    [

        {"costObjectKey": "P2744125-001", "amount": "111"},

        {"costObjectKey": "P2744125-002", "amount": "222"}

    ]
    (create people – :glcategory_id == 'CRAFT-1') addPeopleWrkColl: lineitem_id is omitted | input parms: personnelKey, hrPositionKey, glAccountKey, appointmentKey, granularity, period, allocationCollection must be a json array in the following format:

    [

        {"costObjectKey": "P2744125-001", "allocation": "50"},

        {"costObjectKey": "P2744125-002", "allocation": "50"}

    ]

  • DELETE: deleteExpenseWrk | deletePeopleWrk (:glcategory_id == 'CRAFT1') | revertPeopleWrk (glcategory_id == 'CRAFT1' && revert == 'Y)
/rest/v2/pi/forecast/:forecast_id/glcategory/:glcategory_id
  •  GET: getExpSubtotal/getExpSubOne | getPeopleSubtotal: input parms: worksetKey (req), granularity (req if glcategory_id == 'CRAFT-1' --> M = Monthly, S = Semester, FY = Fiscal Year, AY = Academic Year, Y = Calendar Year, CY = Current Year), startDate (opt), endDate (opt), costObjectKey (opt) if costObjectKey is provided, then the call returns subtotals for a single costobject ONLY

getWorkset: output: Scenario Key, Workset Key, described in RAFTTHREE-605.

getCalendar: GET, returns calendar data, described in https://jira-mit-edu.ezproxyberklee.flo.org/jira/browse/RAFTTHREE-571

addExpenseLine : POST, input parms, scenarioKey, worksetKey, GLCat, Name (default:GlCat), startDate, endDate, rollsOff [Y|N], amortize [Y|N], Single Cost Object Key, returns speculationId (expense line key)

upDateExpenseLine : PUT, input parms, speculationId,scenarioKey, worksetKey, GLCat, Name (default:GlCat), startDate, endDate, rollsOff [Y|N], amortize [Y|N], Single Cost Object Key, 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 :

  1. getWorkset, input parms: Scenario Key, Workset Key; output: success/fail
  2. populateWorksetCache, input parms: Scenario Key, Workset Key, output: success/fail
  3. deleteWorksetCache, input parms: Scenario, output: success/fail
  4. 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)
  5. 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
  6. deleteExpenseLine, DELETE, speculationId, returns status

getExpenseLines :  input parms: Scenario, Budget, Workset, GL category, startDate,endDate, output: array of expense line

Call:

rest/v2/newEndpointTBD/forecast_id/glcategory/glcategory_id/speculation?startDate=date3&endDate=date

Sample:

rest/v2/newEndpointTBD/KDOODYSHAREDCOSTOBJECTC1443501001FORECAST-324790329-004/glcategory/CRAFT-2/speculation?startDate=07%2F01%2F2013&endDate=06%2F30%2F2014

Response:

{ data:
"HEADER":[{COST_COLLECTOR_ID_WITH_TYPE: "P6923933",
COST_COLLECTOR_KEY: "P6923933-001",
COST_COLLECTOR_NAME: "Computing On Encrypted Data: Theory And"
},
{
COST_COLLECTOR_ID_WITH_TYPE: "P6923932",
COST_COLLECTOR_KEY: "P6923932-001",
COST_COLLECTOR_NAME: "Nonparametric Representations For Integr"
},
{
COST_COLLECTOR_ID_WITH_TYPE: "P6926990",
COST_COLLECTOR_KEY: "P6926990-001",
COST_COLLECTOR_NAME: "Fabricated Equipment - Robot Movement Sy"
}
],
"RESULT":[
{
"LVL1":"ForecastData",
"LVL2":"blocks",
"LVL3":"CRAFT-2",
"LVL4":"actuals",
"LVL5":null,
"speculationId":"C1443501-001420226-001",
"speculationName":"Materials and Services",
"glAccountKey":"420226-001",
"glAccountName":"Materials and Services",
"GLCAT_KEY":"CRAFT-2",
"GLCAT_TITLE":"Materials and Services",
"DAYS":"1",
"costObjects": [{COST_COLLECTOR_KEY: "P6923933-001", cost: "5,000"},
{COST_COLLECTOR_KEY: "P6926990-001", cost: "0"},
{COST_COLLECTOR_KEY: "P6923932-001", cost: "12,087"},
}],
"PER_DAY":"131.94",
"startDate":"08\/26\/2013",
"endDate":"10\/18\/2013",
"isRestricted":"Y",
"rollOff":"N",
"description":null,
"DISP":"ACT",
"isDirty":"N"
},
{
"LVL1":"ForecastData",
"LVL2":"blocks",
"LVL3":"CRAFT-2",
"LVL4":"actuals",
"LVL5":null,
"speculationId":"C1443501-001420890-001",
"speculationName":"Subscriptions",
"glAccountKey":"420890-001",
"glAccountName":"Subscriptions",
"GLCAT_KEY":"CRAFT-2",
"GLCAT_TITLE":"Materials and Services",
"DAYS":"1",
"costObjects": [{COST_COLLECTOR_KEY: "P6923933-001", cost: "0"},
{COST_COLLECTOR_KEY: "P6926990-001", cost: "0"},
{COST_COLLECTOR_KEY: "P6923932-001", cost: "0"},
}],
"PER_DAY":"471.9",
"startDate":"09\/01\/2013",
"endDate":"09\/01\/2013",
"isRestricted":"Y",
"rollOff":"N",
"description":null,
"DISP":"ACT",
"isDirty":"N"
},
{
"LVL1":"ForecastData",
"LVL2":"blocks",
"LVL3":"CRAFT-2",
"LVL4":"forecasts",
"LVL5":null,
"speculationId":"C1443501-001421827-001",
"speculationName":"Equip\/Furniture-Minor",
"glAccountKey":"421827-001",
"glAccountName":"Equip\/Furniture-Minor",
"GLCAT_KEY":"CRAFT-2",
"GLCAT_TITLE":"Materials and Services",
"DAYS":"0",
"cost":"0.00",
"PER_DAY":"1893",
"startDate":"11\/04\/2013",
"endDate":"11\/04\/2013",
"isRestricted":"Y",
"rollOff":"N",
"description":null,
"DISP":"COMM",
"isDirty":"N"
},
{
"LVL1":"ForecastData",
"LVL2":"blocks",
"LVL3":"CRAFT-2",
"LVL4":"forecasts",
"LVL5":null,
"speculationId":"KDOODYKDOODYSHAREDCOSTOBJECTC1443501001FORECAST-324790329-004C1443501-001E2014031327090808722522000",
"speculationName":"worms",
"glAccountKey":"420226-001",
"glAccountName":"Materials and Services",
"GLCAT_KEY":"CRAFT-2",
"GLCAT_TITLE":"Materials and Services",
"DAYS":"121",
"costObjects": [{COST_COLLECTOR_KEY: "P6923933-001", cost: "15,000"},
{COST_COLLECTOR_KEY: "P6926990-001", cost: "0"},
{COST_COLLECTOR_KEY: "P6923932-001", cost: "0"},
}],
"PER_DAY":"65.57377049180327868852459016393442622951",
"startDate":"03\/01\/2014",
"endDate":"06\/30\/2014",
"isRestricted":"Y",
"rollOff":"Y",
"description":null,
"DISP":"FORC",
"isDirty":"Y"
}
],
"meta":{
"statusCode":0,
"message":"Success",
"hasData":true
}
}

...

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

 

getNotifications, GET, input parms, object type (expense or people), object id (line item key or pkey), scenario key, worksetkey,

People Calls

getPeopleLines, GET, input parms: Scenario Key, Granularity(months, semesters, fiscal years), start Date, end date

getPeopleSummary, GET, input parms: Scenario Key, Granularity (months, semesters, fiscal years), start Date, end date, budget

getPeopleBalances, GET, input parms: Scenario Key, Granularity (months, semesters, fiscal years),start Date, end date, budget

getGranularitCalendar, GET, input parms: none or TimeFrame(months, semesters, fiscal years)

addPerson, POST, input parms: granularlity, pkey, apptSubtTypeCode, hrpositionKey, co/period allocation collection, startDate and endDAte of current pageset, on/off campus, glAcctKey,

addTBH, POST, input parms:

listTBHS, GET, call CO Forecast version

searchPerson, GET, call CO Forecast version (autocomplete)

updateWorksetAllocation, PUT, input parms: coKey and allocation, scenario key, pkey, apptSubtTypeCode, hrpositionKey,

deletePerson, DELETE, input parms: Scenio Key, personnel key

revertPersonAllocation, input parms: granularity, startDATe and endDATe of current pageset, scenario key, pkey, apptSubtTypeCode, hrpositionKey,, returns ESDS allocation

clearPersonAllocation: input parms: scenario key, pkey, apptSubtTypeCode, hrpositionKey, granularity,