4.18 Add Narrative to Case
This service will allow addition of Narratives to an existing case.
The following topics explain how to add Narrative to an existing Case.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/ECMService/CaseManagementService/addNarrative
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-35 Request Parameter Details
| First Level | Details |
|---|---|
| caseId | This accepts the case internal identifier. |
| narrative | This accepts the narrative text. |
Request JSON Sample
This section contains a request JSON sample to add a Narrative to an existing ECM case. Only plain text will be captured. Formatting, images and screenshots will not be captured. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100",
"narrative": "This case was registered because illegal activities was carried in the joint account linked
to the customer."
}
]Response Parameters
The following table describes the details of the response
parameters.
Table 4-36 Parameter Details
| First Level | Second Level | Details |
|---|---|---|
| MESSAGE | - | Displays the overall response message from the API. |
| STATUS | - | Displays the overall 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 and in case of partial success it will be represented by PARTIALSUCCESS. |
| RESULTARRAY | MESSAGE | Displays the response message from the API for the respective case. |
| RESULTARRAY | STATUS | Displays the status of the API call for the respective 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. |
| RESULTARRAY | caseId | Displays the case internal identifier on which the API was called. |
Response JSON Sample
This section contains a response JSON sample for when narrative addition
to an existing case is successful. The entries in this sample are only for reference
purposes. Refer to Improvements in Real Time Event Creation APIs for additional Response
JSON
samples.
{
"MESSAGE": "Narrative addition was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Narrative added successfully.",
"STATUS": "SUCCESS",
"caseId": "CA240"
},
{
"MESSAGE": "Narrative added successfully.",
"STATUS": "SUCCESS",
"caseId": "CA100"
},
{
"MESSAGE": "Narrative added successfully.",
"STATUS": "SUCCESS",
"caseId": "CA360"
}
]