B.9 Sample Responses for Add External Entity to Case API
This section lists sample responses for the Add External Entity to Case API.
Table B-9 Sample Responses for Add External Entity to Case API
| SL No | Description | Response | Response Type and Status |
|---|---|---|---|
| 1 | This is the response when external Entities addition to an existing case is successful. | {"MESSAGE": "External Entities addition was
successful.","STATUS": "SUCCESS", "RESULTARRAY": [{"MESSAGE":
"External Entities addition was successful.","STATUS":
"SUCCESS","caseId": "CA120","externalEntities": [{"MESSAGE":
"External Entity added successfully.","STATUS":
"SUCCESS","externalEntity": "ACCT1"},{"MESSAGE": "External Entity
added successfully.","STATUS": "SUCCESS","externalEntity":
"ACCIDIOSRMAC-001"}]}] } |
OK 200 |
| 2 | This is the response when externalEntities addition to an existing case is partially successful. | {"MESSAGE": "External Entities addition was partially
successful.","STATUS": "PARTIALSUCCESS", "RESULTARRAY": [{"MESSAGE":
"External Entities addition was successful.","STATUS":
"SUCCESS","caseId": "CA120","externalEntities": [{"MESSAGE":
"External Entity added successfully.","STATUS":
"SUCCESS","externalEntity": "EXACCIBPAACB-06"},{"MESSAGE": "External
Entity added successfully.","STATUS": "SUCCESS","externalEntity":
"ACCIDIOSRMAC-001"}]},{"MESSAGE": "External Entities addition
failed.","STATUS": "FAILED","caseId": "CA100","externalEntities":
[{"MESSAGE": "External Entity does not exist in business.","STATUS":
"FAILED","externalEntity":"ACTRUSTEDPAIR- 038X"},{"MESSAGE":
"External Entity already exists.","STATUS": "FAILED",
"externalEntity": "ACTRUSTED-08X" |
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 addition failed.","STATUS":
"FAILED", "RESULTARRAY": [{"MESSAGE": "External Entities addition
failed.","STATUS": "FAILED","caseId": "CA103","externalEntities":
[{"MESSAGE": "External Entity does not exists.","STATUS":
"FAILED","externalEntity": "ACFTNETRSTCUB-01X"},{"MESSAGE":
"External Entity insertion failed as error occurred while inserting
into externalEntity related tables.","STATUS":
"FAILED","externalEntity": "ACSTCUB-013X"},{"MESSAGE": "Either
existing Institution or new Institution Id and Institution Name
should be specified but not both.","STATUS":
"FAILED","externalEntity": "ACSTCUB-01X"},{"MESSAGE": "Institution
Id and Institution Name both should be specified.","STATUS":
"FAILED","externalEntity": "ACFTNETRSTACB1X_07"},{"MESSAGE":
"External entity risk Source does not exists.","STATUS": "FAILED",
"externalEntity": |
ERROR 500 |
| 5 | This is the response when the request fails because of server errors. | {"MESSAGE": "External Entities addition failed.","STATUS":
"FAILED", "RESULTARRAY": [{"MESSAGE": "Internal error occurred.
Please contact system administrator.","STATUS": "FAILED","caseId":
"CA103"}] } |
ERROR 500 |