4.7 Get ECM Case Status
This service allows the determination of the current status of the Case.
The following topics explain how to get ECM case status.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/ECMService/CaseManagementService/getCaseStatusDetails
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-13 Request Parameter Details
| First Level | Details |
|---|---|
| caseId | This accepts the case internal identifier. |
Request JSON Sample
This section contains a request JSON sample to accept the case ID for which the status need to be known. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100"
}
]Response Parameters
The following table describes the details of the response parameters for
a JSON Sample when case description is updated successfully.
Table 4-14 Parameter Details
| First Level | Second Level | Details |
|---|---|---|
| MESSAGE | - | Displays the response message from the API. |
| STATUS | - | Displays the status of the API call whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED. |
| RESPONSEARRAY | MESSAGE | Displays the response message for the Individual Case. |
| RESPONSEARRAY | STATUS | Displays the status of the API call for the Individual case whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED. |
| RESPONSEARRAY | caseId | Displays the case internal identifier on which the API was called. |
| RESPONSEARRAY | caseStatusCode | Displays the current Status code of the case. |
| RESPONSEARRAY | caseStatusName | Displays the current Status Name of the case. |
| RESPONSEARRAY | caseStatusDateTime | Displays the time at which the current status of the case was set. |
| RESPONSEARRAY | caseClosedFlag | Indicates if the case is in a closed status. |
Response JSON Sample
This section contains a response JSON sample for when ECM case status is
successfully fetched. Refer to Improvements in Real Time Event Creation APIs for additional Response
JSON samples. The entries in this sample are only for reference
purposes.
{
"MESSAGE": "Case Status fetch Successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Case status fetch successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"caseStatusCode": "INV",
"caseStatusName": "Investigation",
"caseStatusDateTime": "2022-06-24 10:28:48",
"caseClosedFlag": "N"
}
]
}