Search
K
Illustration

Result

array

The output from a cmputation, which may vary with time

Scenario-Results

object

A grouping of uniquely identifiable results, typically produced under a common set of assumptions

^[a-z][a-zA-Z0-9]+array[string]

The output from a cmputation, which may vary with time

Example
{
  "^[a-z][a-zA-Z0-9]+": [
    "[]"
  ]
}

Multiple-Scenario-Results

object

A grouping of uniquely identifiable scenarios containing their results

Message

object

A structured signal

codeintegerrequired
severitystring

Allowed values:INFOWARNINGERROR

textstringrequired
returnTostring
Example
{
  "code": 0,
  "severity": "INFO",
  "text": "text",
  "returnTo": "returnTo"
}

Core Calculation - Single Illustration

Describes the payload required for calculation of a single transaction

$schemastring
illustrationTypestringrequired

Allowed values:NEW_BUSINESSINFORCE

calculationTypestringrequired

Type of calculation

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTION

Example:QUICK_QUOTE

policyDetail

Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.

Show Child Parameters
projection
Show Child Parameters
Example
{
  "$schema": "$schema",
  "illustrationType": "NEW_BUSINESS",
  "calculationType": "QUICK_QUOTE",
  "policyDetail": "",
  "projection": ""
}