4.13 Add External Entity to Case
This service will allow addition of external Entities to an existing ECM case.
The following topics explain how to add External Entities 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/addExternalEntity
Service Type
The service type is POST.
Request Parameters
Table 4-25 Request Parameter Details
First Level | Second Level | Third Level | Details |
---|---|---|---|
caseId | - | - | This accepts the case internal identifier. |
externalEntities | externalEntity | - | This accepts the externalEntity internal identifier. |
externalEntities | businessAdd | - | This identifies whether externalEntity addition needs to be done from business or not. Y states externalEntity needs to be added from business. N states externalEntity needs to be manually added. |
externalEntities | externalEntityTypeCode | - | This accepts the externalEntity type code value. |
externalEntities | lastActivityDate | - | This accepts the externalEntity last activity date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. |
externalEntities | riskRating | - | This accepts the externalEntity risk rate value. |
externalEntities | jurisdictionCode | - | This accepts the externalEntity jurisdiction code value. |
externalEntities | businessDomainCode | - | This accepts the externalEntity business domain code value. |
externalEntities | institution | - | This accepts the externalEntity institution value. |
externalEntities | institutionName | - | This accepts the externalEntity institution name. |
externalEntities | institutionId | - | This accepts the externalEntity institution id. |
externalEntities | contactInformation | addressLine1 | This accepts the address line1 for externalEntity contact information. |
externalEntities | contactInformation | addressLine2 | This accepts the address line2 for externalEntity contact information. |
externalEntities | contactInformation | addressLine3 | This accepts the address line3 for externalEntity contact information. |
externalEntities | contactInformation | addressLine4 | This accepts the address line4 for externalEntity contact information. |
externalEntities | contactInformation | addressLine5 | This accepts the address line5 for externalEntity contact information. |
externalEntities | contactInformation | addressLine6 | This accepts the address line6 for externalEntity contact information. |
externalEntities | contactInformation | city | This accepts the city for externalEntity contact information. |
externalEntities | contactInformation | state | This accepts the state for externalEntity contact information. |
externalEntities | contactInformation | postalCode | This accepts the postal code for externalEntity contact information. |
externalEntities | contactInformation | countryCode | This accepts the country code value for externalEntity contact information. |
externalEntities | riskListMembership | riskSource | This accepts the risk list membership risk source value for the externalEntity. |
externalEntities | riskListMembership | addedDate | This accepts the risk list membership added date time for the externalEntity. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. |
externalEntities | riskListMembership | removedDate | This accepts the risk list membership removed date time for the externalEntity. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. |
externalEntities | riskListMembership | matchedName | This accepts the risk list membership matched name value for the externalEntity. |
externalEntities | riskListMembership | entryDescription | This accepts the risk list membership entry description for the externalEntity. |
externalEntities | genericInformation | - | This accepts generic information about the externalEntity. |
Request JSON Sample
This section contains a request JSON sample to add external Entities to an existing case. The API will accept multiple caseIds and external Entities information to be added to the case. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100",
"externalEntities": [
{
"externalEntity": "ACCIDIOSRMAC-001",
"businessAdd": "N",
"externalEntityTypeCode": "XA",
"lastActivityDate": "2021-06-24 11:00:48",
"riskRating": 2,
"jurisdictionCode": "AMEA",
"businessDomainCode": "A",
"institution": "Oracle",
"institutionName": "BGMC_ACCT_001",
"institutionId": "12345",
"contactInformation": [
{
"addressLine1": "Wall Street 101",
"addressLine2": "College Road",
"addressLine3": "Near Bentley Showroom",
"addressLine4": "Next to Rod Stadium",
"addressLine5": "Max Lab Division",
"addressLine6": "Power Lane",
"city": "New York",
"state": "North",
"postalCode": "12345-123",
"countryCode": "US"
}
],
"riskListMembership": [
{
"riskSource": "P8C",
"addedDate": "2022-06-15 10:00:00",
"removedDate": "2022-06-20 10:00:48",
"matchedName": "P8C",
"entryDescription": "P8C"
}
],
"genericInformation": {
"External Entity Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234",
"External Entity No": "AD1234567"
},
"Enterprise External Entity Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fraudulent Transaction",
"External Entity Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}
]
}
]
Response Parameters
Table 4-26 Parameter Details
First Level | Second Level | Third 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 and in case of partial success it will be represented by PARTIALSUCCESS. | |
RESULTARRAY | caseId | Displays the case internal identifier on which the API was called. | |
RESULTARRAY | externalEntities | MESSAGE | Displays the response message from the API for the respective externalEntity under the respective case. |
RESULTARRAY | externalEntities | STATUS | Displays the status of the API call for the respective externalEntity under 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 | externalEntities | externalEntity | Displays the externalEntity internal identifier under the respective case on which the API was called. |
Response JSON Sample
{
"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"
}
]
}
]
}