B.10 Sample Responses for Remove External Entity from Case API
This section lists sample responses for the Remove External Entity from Case API.
Table B-10 Sample Responses for Remove External Entity from Case API
| SL No | Description | Response | Response Type and Status |
|---|---|---|---|
| 1 | This is the response when external entities removal from an existing case is successful. | {"MESSAGE": "External Entities removal was
successful.","STATUS": "SUCCESS", "RESULTARRAY": [{"MESSAGE":
"External Entities removal was successful.","STATUS":
"SUCCESS","caseId": "CA100","externalEntities": [{"MESSAGE":
"External Entity removed successfully.","STATUS":
"SUCCESS","externalEntity": "ACFTNETRSTACO1X"},{"MESSAGE": "External
Entity removed successfully.","STATUS": "SUCCESS","externalEntity":
"TERRY FRANCONA"}]}] } |
OK 200 |
| 2 | This is the response when external entities removal from an existing case is partially successful. | {"MESSAGE": "External Entities removal was partially
successful.","STATUS": "PARTIALSUCCESS", "RESULTARRAY": [{"MESSAGE":
"External Entities removal was successful.","STATUS":
"SUCCESS","caseId": "CA100","externalEntities": [{"MESSAGE":
"External Entity removed successfully.","STATUS":
"SUCCESS","externalEntity": "ACFTNETRSTACO1X"},{"MESSAGE": "External
Entity removed successfully.","STATUS": "SUCCESS","externalEntity":
"TERRY FRANCONA"}]},{"MESSAGE": "External Entities removal
failed.","STATUS": "FAILED","caseId": "CA101","externalEntities":
[{"MESSAGE": "External Entity does not exist in case.","STATUS":
"FAILED","externalEntity": "ACTRUSTEDPAIR- 038X"}]}]
} |
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": "External Entities removal failed.","STATUS":
"FAILED", "RESULTARRAY": [{"MESSAGE": "External Entities removal
failed.","STATUS": "FAILED","caseId": "CA103","externalEntities":
[{"MESSAGE": "External Entity removal failed as error occurred while
deletingfrom External Entity related tables.","STATUS":
"FAILED","externalEntity": "ACTRUSTEDPAIR- 037X"}]},{"MESSAGE":
"Case does not exist.", "STATUS": "FAILED","caseId":
"CA3600","externalEntities":[{"MESSAGE": null, "STATUS":
null,"externalEntity": null}]},{"MESSAGE": "Case is locked by
another user CASEANA1.","STATUS": "FAILED","caseId":
"CA360","externalEntities": [{"MESSAGE": null, "STATUS": null,
"externalEntity": null |
ERROR 500 |
| 5 | This is the response when the request fails because of server errors. | {"MESSAGE": "External Entities removal failed.","STATUS":
"FAILED", "RESULTARRAY": [{"MESSAGE": "Internal error occurred.
Please contact system administrator.","STATUS": "FAILED","caseId":
"CA103"}] } |
ERROR 500 |