B.14 Sample Responses for Add Narrative to Case API
This section lists sample responses for the Add Narrative to Case API.
Table B-14 Sample Responses for Add Narrative to Case API
SL No | Description | Response | Response Type and Status |
---|---|---|---|
1 | This is the response when narrative addition to an existing case is either successful. | {"MESSAGE": "Narrative addition was successful.","STATUS":
"SUCCESS", "RESULTARRAY": [{"MESSAGE": "Narrative
addedsuccessfully.","STATUS": "SUCCESS","caseId":
"CA240"},{"MESSAGE": "Narrative addedsuccessfully.","STATUS":
"SUCCESS","caseId": "CA100"},{"MESSAGE": "Narrative
addedsuccessfully.","STATUS": "SUCCESS","caseId":
"CA360"}]} |
OK 200 |
2 | This is the response when narrative addition to an existing case is partially successful. | {"MESSAGE": "Narrative addition was partially
successful.","STATUS": "PARTIALSUCCESS", "RESULTARRAY": [{"MESSAGE":
"Narrative added successfully.","STATUS": "SUCCESS","caseId":
"CA100"},{"MESSAGE": "Narrative addition failedas error occurred
while inserting into narrative related tables.","STATUS":
"FAILED","caseId": "CA101"}] } |
OK 200 |
3 | This is the response when there is a problem with the input data. | {"MESSAGE": "Invalid JSON Input format. Please correct the
data.","STATUS": "FAILED" } |
ERROR 400 |
4 | This is the response when the request fails because multiple errors. | {"MESSAGE": "Narrative addition failed.", "STATUS":
"FAILED","RESULTARRAY": [{"MESSAGE": "Narrative addition failedas
error occurred while inserting into narrative related
tables.","STATUS": "FAILED","caseId": "CA103"},{"MESSAGE": "Case
does not exist.", "STATUS": "FAILED","caseId": "CA3600"},{"MESSAGE":
"Case is locked by another user CASEANA1.","STATUS":
"FAILED","caseId": "CA360"}] } |
ERROR 500 |
5 | This is the response when the request fails because of server errors. | {"MESSAGE": "Narrative addition failed.", "STATUS":
"FAILED","RESULTARRAY": [{"MESSAGE": "Internal error occurred.
Please contact system administrator.","STATUS": "FAILED","caseId":
"CA103"}] } |
ERROR 500 |