Exec Endpoint

The web service will initially expose an endpoint for model invocation at a URL of the form:

• https://test.riseapi.net/frmws/ism/v1/exec (development)
• https://www.riseapi.net/frmws/ism/v1/exec (production)

Note that web service requests to the exec endpoint should use the POST HTTP/S method, with the data payload populated with a JSON expression of the inputs. The client request should assign a MIME content-type of application/json to the POST, and ensure the same MIME type is included in the Accept header. As an example, a simple post via ajax might look like:

$('#postResults').click(function () {
    $.ajax({
        type: "post",
        headers: {
            "Authorization": "bearer " + $("#token").val()
        },
        dataType: "json",
        contentType: 'application/json',
        url: "http://chicrise1.cloudapp.net/frmws/ism/v1/exec",
        data: $("#postjson").val(), // Put your json document here
        success: function (value) {
            // Do Something with the json response (this just prints it to text box)
            $('#resultsbox').val(JSON.stringify(value, null, '\t'));
        }
    });
 });

Request

Inputs for the web service (and ultimately for the income security score model) are described in the table below. Note that the JSON example provided in the final section conveys the overall structure of the input payload – this table is meant to detail the individual data points, complete with data type, allowable values, defaults, etc. Note also that all parent objects other than data/id and data/type reside under the “attributes” parent. This was excluded for brevity.

* The portfolio object is an array and can contain any number of income or expense accounts, where the individual categorization, allocation and cash flows for each income/expense account conform to the semantics described in the table above.

** The allocation object is a sub-array within the portfolio accounts and can contain any number of allocations, where the individual allocation and fees conform to the semantics described in the table above. Note that while the number of allocations is not prescribed, the sum of the weights, however, must equal unity (1.0). The allocation array is optional.

*** The cashflows object is designed to inform the RISE model with respect to cash flow generation. The cashflows object reflects the UML diagram listed below, and therefore contains many sub-types, each of which may require different elements to be present in the JSON document. The structure will be validated accordingly, but note that this document is a work-in-progress and some specialized cash flow items remain to be documented in the table above.

**** The majority of cash flows will be in objects other than ‘explicit’. Further, the majority of cash flows are expected to be basic ‘parameterized’ representations.

Response

Outputs for the web service (derived from the income security score model) are described in the table below. Note that the JSON example provided in the last section of this document conveys the overall structure of the output payload – this table is meant to detail the individual data points, complete with data type, allowable values, defaults, etc.

* The attributes object is an array and may convey income security scores for any number of product/allocation combinations.

** The products object is an array under attributes – there can be multiple products and allocations associated with a single score.