Get Formulas Structures API

Example

A user makes a call for the formula structure for an insurance product, based on the code of that product. The user wants the formula structure which was valid at a certain date - respectively, 2021-05-21.

Copy

1
2
3
4
5
6
7
8
let p = {
    "productCode": "BA_EMB"
    "validityDate": "2021-05-21"
}
ebs.callActionByNameAsync("FTOS_IP_GetProductFormulasStructuresAPI", p)
    .then(function(e) {
        console.log(e)
    })

Request data parameters

Here is the list of data parameters included in the request:

Parameter	Description
productCode	The code of the Insurance Product.
validityDate	The reference date, prior to the current date, for getting an earlier version of the product formulas structure. This key is not mandatory. When it is not provided, the API calls the current version of the formula. Accepted formats are: yyyy-mm-dd, dd/mm/yyyy, dd-mm-yyyy, or dd.mm.yyyy.

Response

This is an example of a response:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{
  "isSuccess": true,
  "errorMessage": null,
  "errorCode": null,
  "result": [
    {
      "productCode": "BA_EMB",
      "premiumCalculationStructures": [
        {
          "code": "HHR0",
          "formulaVersion": 1.0,
          "formulaStructure": [
            {
              "key": "risks",
              "value": null,
              "masterType": "Collection",
              "subType": "Object",
              "objProps": "{\"Risk\":6,\"Module\":6,\"Price\":2}"
            },
            {
              "key": "propertyInsuredAmount",
              "value": null,
              "masterType": "SimpleType",
              "subType": "Decimal",
              "objProps": null
            },
            {
              "key": "propertyConstructionYear",
              "value": null,
              "masterType": "SimpleType",
              "subType": "WholeNumber",
              "objProps": null
            }
          ]
        },
        {
          "code": "HA",
          "formulaVersion": 1.0,
          "formulaStructure": [
            {
              "key": "buildingInsuredAmount",
              "value": null,
              "masterType": "SimpleType",
              "subType": "Decimal",
              "objProps": null
            },
            {
              "key": "constructionYear",
              "value": null,
              "masterType": "SimpleType",
              "subType": "WholeNumber",
              "objProps": null
            }
          ]
        }
      ],
      "uwRulesStructures": [
        {
          "contextType": "Underwriting",
          "formulaVersion": 1.0,
          "formulaStructure": [
            {
              "key": "insuredAmount",
              "value": null,
              "masterType": "SimpleType",
              "subType": "Decimal",
              "objProps": null
            },
            {
              "key": "seismicZone",
              "value": null,
              "masterType": "SimpleType",
              "subType": "Text",
              "objProps": null
            }
          ]
        }
      ]
    }
  ]
}

Response description:

Key	Description
Error code	Error code.
Error message	Error message.
isSuccess	Marks whether the request was successful or not.
result	Array of objects containing details about the prices.
productCode	The code of the Insurance Product.
premiumCalculationStructures	Array with each premium formula input parameters attached to a product item.
uwRulesStructures	Array with each underwriting formula input parameters attached to a product .

Error Messages

The following are the error messages that can be encountered while calling the GetFormulasStructuresAPI:

Code	Text	Description
ERR.IP.50201	ERR.IP.50201 - Invalid validity date format! Please, use yyyy-mm-dd or dd/mm/yyyy or dd-mm-yyyy or dd.mm.yyyy!	Invalid date format for validityDate input parameter.
ERR.IP.50202	ERR.IP.50202 - Invalid validity date!	Invalid date for validityDate input parameter.
ERR.IP.50203	ERR.IP.50203 - Invalid key request!	Missing parameters in the request or wrong parameter name.
ERR.IP.50204	ERR.IP.50204 - No active product identified!	No active insurance product found.
ERR.IP.50205	ERR.IP.50205 - Error! The //code of product// insurance product was not approved at the requested date!	No active insurance product found at the date specified in validityDate input parameter.
ERR.IP.50206	ERR.IP.50206 - Underwriting context type is not defined!	The underwriting context type is not defined.

Endpoints

The FTOS_IP_GetProductFormulasStructuresAPI endpoint is responsible for getting the formulas input parameters structure for premium calculation for each product item and, also, for getting the formulas input parameters structure for the underwriting rules defined on product level.

Server Side Script Libraries

From the FTOS_IP_InsuranceProductAPIs library, the GetFormulaInputParameters() function is used for getting the input parameters structure for the premium and underwriting formulas. The GetFormulaInputParameters() function wraps the following functions, necessary for validating and returning the input parameters structure: