Legacy Input API

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

• Optimo API test view
• Downloading the Optimo API Sample Code
• How to Read the Functions Documentation

The list of all functions is here.

OnLoadLegacySampleCase() function – Load a Sample Legacy Case

This JavaScript function does not directly use the API. It in used in API Test View to load a couple of sample objects in the legacy JSON format into the “#resultjson” <pre> tag. This can then be used to push a case in the next step.

function OnLoadLegacySampleCase() {
    $("#resultjson").show().html(JSON.stringify(legacyCase, null, 2));
    $("#apiresult").html("Sample legacy case loaded.");
}

/service/pushLegacyCase function – Push new or existing Legacy Case

This sample code pushes a sample case in legacy JSON format.

function OnPushLegacyCase() {
    var url = '/service/pushlegacycase';
    var data = JSON.parse($("#resultjson").html());
    OnGetJson(url, data);
}

/service/getLegacyCase function – Get Existing Legacy Case

This sample code will retrieve the current case as set by a previous call to /service/setCase, in legacy JSON format.

function OnGetLegacyCase() {
    var guid = $('#scenarioguid').val();
    OnGetJson('/service/getlegacycase', {
        scenarioGuid: guid
    });
}

Frequencies

For some fields in the input API, a frequency should be specified. If a frequency is not specified then, in Pathfinder it will default to 'Annual'.

If the JSON file contains a frequency that is not listed in the table below, then in Pathfinder it will appear as 'Invalid' and will be flagged with an error so the user will need to correct it before they can solve the case.

An example of the JSON with frequency=Week is:

{

        "id": 7,

        "name": "Ravi weekly business income ",

        "ownerId": 1,

        "type": "Business",

        "amount": {

          "value": 2000,

          "frequency": "Week"

        }

      }