Search
K
Case Management

Case Management API

1.0.0OAS 3.0

Maintains cases and tasks apis related to the policy lifecycle.

API Base URL
  • Server 1:https://dev.api.zinnia.io/

    Dev Environment

  • Server 2:https://qa.api.zinnia.io/

    QA Environment

  • Server 3:https://uat.api.zinnia.io/

    UAT Environment

  • Server 4:https://api.zinnia.io/

    PROD Environment

Case Instance

Manages cases for all processes

Get Case Detail

Retrieve the case instance details using the system identifier (caseId).

get

Path Parameters

caseIdstringrequired

Case instance id

Example:CA0000360227

Response

application/json

Case details retrieved

CaseInstance

_idstring

Unique identifier for the case instance.

templateIdstring

Identifier for the template associated with the case instance.

carrierstring

Name of the carrier associated with transaction/case.

processstring

Name of the process/transaction type for case.

caseGroupstring

Name of the caseGroup type for case.

parentInstanceIdstring

Identifier for the parent case instance, if applicable.

correlationIdstring

Identifier used for correlating events as they received.

caseStatusstring

Current status of the case instance.

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED

caseResultstring

Contextual information regarding the caseStatus especially when case is marked as canceled

caseResultDetailstring

Detailed contextual information regarding the caseStatus

primaryboolean

Indicates if this is the primary case instance.

escalatedboolean

Indicates if the case instance has been escalated.

caseProcessingDetailsarray[object]

List of detail sections for case processing.

Show Child Parameters
linkDetailsobject

Details about linked case instances.

Show Child Parameters
processSubTypestring

Subtype of the process/transaction associated with the case.

policyNumberstring

Policy number/Contract No associated to the case instance.

planCodestring

PlanCode associated to the case instance.

productNamestring

Name of the product associated with Contract/Policy.

documentsarray[object]DEPRECATED

List of document associated to the case. (DEPRECATED)

Show Child Parameters
exceptionsarray[object]

List of all exceptions/NIGOs associated related to the case.

Show Child Parameters
notesarray[object]

List of all note associated to the case.

Show Child Parameters
tasksarray[object]

List of all tasks associated to the case irrespective of different stage/steps.

Show Child Parameters
mappedTasksarray[string]

List of Task Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedExceptionsarray[string]

List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedNotesarray[string]

List of Notes Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

mappedDocumentsarray[string]

List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)

partiesarray[object]

List of individuals/parties associated with the contract/policy related to the case

Show Child Parameters
identifiersarray[object]

An object representing an identifier and its corresponding value.

Show Child Parameters
additionalDataOne Of
DEPRECATED

Additional data related to the case. (DEPRECATED)

CaseAdditionalDataNBobject
Show Child Parameters
stagesarray[object]

List of stages representing milestone in the journey of a case/transaction.

Show Child Parameters
createdAtstring(date-time)

Timestamp when the case instance was created, derived from the time of the initial event.

updatedAtstring(date-time)

Timestamp when the case instance was last updated, derived from the time of the latest event.

systemUpdatedDtstring(date)

The date when the system was last updated.

deletedboolean

Indicates if the case instance has been deleted.

techExceptionStatusstring

Overall status of technical exceptions on the case

techExceptionCountinteger(int32)

Total count of technical exceptions on the case

get/case/v1/cases/{caseId}
 
application/json