Skip to main content
Skip table of contents

Scenarios



Before using the functions on this page, you may find it useful to review the following information:

The list of all functions is here.


Description of this function

Get a list of scenarios within the current case as JSON

Once a case is selected the user can get a list of scenarios within that case by calling code similar to the following.

JS
function OnGetScenarios() {
    OnGetJson('/service/getscenarios', {});
}

A sample return from calling this function is as follows. The returned "Guid" parameter must be used for any subsequent applicable API calls. If the "Guid" is blank, it means that no results are avaialble for that scenario (i.e. the user needs to first solve the case to get results).

JS
[
  {
    "AnalysisYears": 20,
    "Guid": "f95e49ab-9956-4364-b397-ab07ba8632c2",
    "Scenario": "Keep super & Buy property",
    "SolvedOn": "/Date(1647478038987)/",
    "IsPinned": false,
    "PinnedOn": "/Date(-62135596800000)/",
    "PinnedSolutionId": "",
    "PinnedByUserId": "",
    "PinnedByUserName": "",
    "TaskSolveStatus": 0,
    "PublishedId": "",
    "Reference": "-9223372015379939326"
  },
  {
    "AnalysisYears": 20,
    "Guid": "",
    "Scenario": "New SMSF w Property",
    "SolvedOn": "/Date(-62135596800000)/",
    "IsPinned": false,
    "PinnedOn": "/Date(-62135596800000)/",
    "PinnedSolutionId": "",
    "PinnedByUserId": "",
    "PinnedByUserName": "",
    "TaskSolveStatus": 0,
    "PublishedId": "",
    "Reference": "-9223372015379939302"
  },
  {
    "AnalysisYears": 20,
    "Guid": "",
    "Scenario": "Basic cash flows",
    "SolvedOn": "/Date(-62135596800000)/",
    "IsPinned": false,
    "PinnedOn": "/Date(-62135596800000)/",
    "PinnedSolutionId": "",
    "PinnedByUserId": "",
    "PinnedByUserName": "",
    "TaskSolveStatus": 0,
    "PublishedId": "",
    "Reference": "-9223372015379939296"
  }
]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.