Illustration-Client-Cases
Update an existing illustration from an existing client case
patch
https://uat.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}
Path Parameters
caseIdstring(uuid)required
illustrationIdstring(uuid)required
Body
Body
IllustrationCreationInputDto
* Additional properties are NOT allowed.
idstring(uuid)required
productTypestringrequired
Allowed values:TERMUNIVERSAL_LIFEINDEX_UNIVERSAL_LIFEWHOLE_LIFEHYBRID_IUL_TERM
productIdstringrequired
>= 1 characters
carrierCodestring | null
titlestring | null
inputsstring | null
productFamilyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
policyIdstring | null
Response
application/json
Response
application/json
Illustration removed successfully
ClientCaseDto
* Additional properties are NOT allowed.
agencyIdstring | null
agencyNamestring | null
agencyCarrierCodestring | null
idstring(uuid)
carrierCodearray | null[string]
submittedboolean
titlestring | null
caseManagementCaseIdstring | null
eAppIdstring | null
planCodearray | null[string]
allowAgentEditboolean
agentDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
insuredDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
transactionTypestring
Allowed values:REPLACEMENTNONREPLACEMENTCONVERSION
isMecboolean
originalFaceAmountnumber | null(double)
policyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
productFamilyIdstring | null
productIdstring | null
createdstring | null(date-time)
illustrationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
lastModifiedstring(date-time)
lastModifiedBystring | null
createdBystring | null
creatorNamestring | null
patch/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}
Authentication
Path Parameters
Body
{
"id": "id",
"productType": "TERM",
"productId": "productId"
}
application/json
Archive an existing illustration
patch
https://uat.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/archive
Path Parameters
caseIdstring(uuid)required
illustrationIdstring(uuid)required
Response
application/json
Response
application/json
Illustration archived successfully
ClientCaseDto
* Additional properties are NOT allowed.
agencyIdstring | null
agencyNamestring | null
agencyCarrierCodestring | null
idstring(uuid)
carrierCodearray | null[string]
submittedboolean
titlestring | null
caseManagementCaseIdstring | null
eAppIdstring | null
planCodearray | null[string]
allowAgentEditboolean
agentDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
insuredDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
transactionTypestring
Allowed values:REPLACEMENTNONREPLACEMENTCONVERSION
isMecboolean
originalFaceAmountnumber | null(double)
policyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
productFamilyIdstring | null
productIdstring | null
createdstring | null(date-time)
illustrationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
lastModifiedstring(date-time)
lastModifiedBystring | null
createdBystring | null
creatorNamestring | null
patch/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/archive
Authentication
Path Parameters
application/json
Reactivates a previously archived illustration.
patch
https://uat.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/reactivate
Path Parameters
caseIdstring(uuid)required
illustrationIdstring(uuid)required
Response
application/json
Response
application/json
Illustration reactivated successfully
ClientCaseDto
* Additional properties are NOT allowed.
agencyIdstring | null
agencyNamestring | null
agencyCarrierCodestring | null
idstring(uuid)
carrierCodearray | null[string]
submittedboolean
titlestring | null
caseManagementCaseIdstring | null
eAppIdstring | null
planCodearray | null[string]
allowAgentEditboolean
agentDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
insuredDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
transactionTypestring
Allowed values:REPLACEMENTNONREPLACEMENTCONVERSION
isMecboolean
originalFaceAmountnumber | null(double)
policyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
productFamilyIdstring | null
productIdstring | null
createdstring | null(date-time)
illustrationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
lastModifiedstring(date-time)
lastModifiedBystring | null
createdBystring | null
creatorNamestring | null
patch/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/reactivate
Authentication
Path Parameters
application/json
Selects an illustration from an existing client case.
DEPRECATEDpatch
https://uat.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/submit
Path Parameters
caseIdstring(uuid)required
illustrationIdstring(uuid)required
Response
application/json
Response
application/json
Illustration selected successfully
ClientCaseDto
* Additional properties are NOT allowed.
agencyIdstring | null
agencyNamestring | null
agencyCarrierCodestring | null
idstring(uuid)
carrierCodearray | null[string]
submittedboolean
titlestring | null
caseManagementCaseIdstring | null
eAppIdstring | null
planCodearray | null[string]
allowAgentEditboolean
agentDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
insuredDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
transactionTypestring
Allowed values:REPLACEMENTNONREPLACEMENTCONVERSION
isMecboolean
originalFaceAmountnumber | null(double)
policyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
productFamilyIdstring | null
productIdstring | null
createdstring | null(date-time)
illustrationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
lastModifiedstring(date-time)
lastModifiedBystring | null
createdBystring | null
creatorNamestring | null
patch/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/submit
Authentication
Path Parameters
application/json
Selects an illustration from an existing client case.
patch
https://uat.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/select
Path Parameters
caseIdstring(uuid)required
illustrationIdstring(uuid)required
Response
application/json
Response
application/json
Illustration selected successfully
ClientCaseDto
* Additional properties are NOT allowed.
agencyIdstring | null
agencyNamestring | null
agencyCarrierCodestring | null
idstring(uuid)
carrierCodearray | null[string]
submittedboolean
titlestring | null
caseManagementCaseIdstring | null
eAppIdstring | null
planCodearray | null[string]
allowAgentEditboolean
agentDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
insuredDetailsobject
* Additional properties are NOT allowed.
Show Child Parameters
transactionTypestring
Allowed values:REPLACEMENTNONREPLACEMENTCONVERSION
isMecboolean
originalFaceAmountnumber | null(double)
policyIdstring | null
illustrationTypestring
Allowed values:NEW_BUSINESSWHAT_IF_IN_FORCE
productFamilyIdstring | null
productIdstring | null
createdstring | null(date-time)
illustrationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
lastModifiedstring(date-time)
lastModifiedBystring | null
createdBystring | null
creatorNamestring | null
patch/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/select
Authentication
Path Parameters
application/json