Illustration-Client-Cases

Search for client cases

Search for client cases using query parameters as filters. Returns all client cases accessible by the logged user that match all filters specified. If no filters are specified returns all client cases accessible by the logged user

get
https://dev.api.zinnia.io/client-case-manager/v1/client-case/search

Query Parameters

titlestring
agentFirstNamestring
agentLastNamestring
insuredFirstNamestring
insuredLastNamestring
eAppIdstring
caseManagementCaseIdstring
creatorNamestring
offsetinteger(int32)

Default:0

>= 0<= 2147483647

limitinteger(int32)

Default:50

>= 1<= 100

sortBystring

Allowed values:TitleAgentFirstNameAgentLastNameInsuredFirstNameInsuredLastNameLastModified

sortDirstring

Allowed values:AscendingDescending

Response

200 application/json

Search executed successfully. List of client case summaries is returned

ClientCaseSummaryDtoResultsPage

* Additional properties are NOT allowed.
countinteger(int64)
nextstring | null
previousstring | null
resultsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
get/client-case-manager/v1/client-case/search
 
200 application/json

Add an illustration to an existing client case

CarrierCode is required for POST requests.

post
https://dev.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations

Path Parameters

caseIdstring(uuid)required

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

Illustration added 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
post/client-case-manager/v1/client-case/{caseId}/illustrations

Body

{ "id": "id", "productType": "TERM", "productId": "productId" }
 
application/json

Remove an illustration from an existing client case

delete
https://dev.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}

Path Parameters

caseIdstring(uuid)required
illustrationIdstring(uuid)required

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
delete/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}
 
application/json

Update an existing illustration from an existing client case

patch
https://dev.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}

Path Parameters

caseIdstring(uuid)required
illustrationIdstring(uuid)required

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

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}

Body

{ "id": "id", "productType": "TERM", "productId": "productId" }
 
application/json

Archive an existing illustration

patch
https://dev.api.zinnia.io/client-case-manager/v1/client-case/{caseId}/illustrations/{illustrationId}/archive

Path Parameters

caseIdstring(uuid)required
illustrationIdstring(uuid)required

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
 
application/json