Illustration-Generation
Illustration Engine
API Endpoints for use by the internal illustration engines
Create an illustration
Start an asynchronous illustration calculation
post
https://uat.api.zinnia.io/illustration/v3/illustration-request
Query Parameters
formatsarray[string]required
identifier for an output format
Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF
Body
application/json
Body
application/json
contains all the input data needed for processing the request
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
Response
application/json
Response
application/json
The request was created, the identifier for the request is returned.
object
post/illustration/v3/illustration-request
Authentication
Query Parameters
Body
{
"illustrationType": "NEW_BUSINESS",
"calculationType": "QUICK_QUOTE"
}
application/json
Get a specific illustration
Get status of a specific asynchronous calculation request
get
https://uat.api.zinnia.io/illustration/v3/illustration-request/{id}
Query Parameters
formatstring
identifier for an output format
Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF
Path Parameters
idstringrequired
the illustration request identifier for which status information is desired
Response
application/json
Response
application/json
The request has been processed and results may be retrieved.
One Offormatstring
identifier for an output format
Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF
statusstring
Allowed values:PENDINGCOMPLETEERROR
get/illustration/v3/illustration-request/{id}
Authentication
Path Parameters
Query Parameters
application/json
Get a specific illustration result
Retrieve the results for the specified illustration request in the specified format
get
https://uat.api.zinnia.io/illustration/v3/illustration-request/{id}/results/{format}
Path Parameters
idstringrequired
The unique identifier for the illustration request.
formatstringrequired
identifier for an output format
Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF
Response
Response
The content was successfully retrieved.
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
get/illustration/v3/illustration-request/{id}/results/{format}
Authentication
Path Parameters
Illustration for immediate processing
Triggers an immediate calculation and returns the calculated results.
post
https://uat.api.zinnia.io/illustration/v3/illustration
Body
application/json
Body
application/json
contains all the input data needed for processing the request
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
Response
application/json
Response
application/json
the request was processed
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
post/illustration/v3/illustration
Authentication
Body
{
"illustrationType": "NEW_BUSINESS",
"calculationType": "QUICK_QUOTE"
}
application/json