4.16 Remove Transaction from Case

This service will allow removal of transactions from an existing case.

The following topics explain how to remove Transactions from an existing Case.

HTTP Link

http:// <Application URL>/rest-api/ECMService/CaseManagementService/removeTransaction

Service Type

The service type is POST.

Request Parameters

The following table describes the details of the parameters.

Table 4-31 Request Parameter Details

First Level Second Level Details
caseId - This accepts the case internal identifier.
transactions transactionReferenceId This accepts the transaction reference identifier.
transactions transactionTypeCode This accepts the transaction type code value.

Request JSON Sample

This section contains a request JSON sample to remove customers from a case. It will accept multiple caseIds and customer information to be removed from the case.

[
{
"caseId": "CA100",
"transactions": [
{
"transactionReferenceId": "BOTRXNCSTLOSSSEVHH004",
"transactionTypeCode": "B"
}
]
}
]

Response Parameters

The following table describes the details of the response parameters.

Table 4-32 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 transactions MESSAGE Displays the response message from the API for the respective transaction under the respective case.
RESULTARRAY transactions STATUS Displays the status of the API call for the respective transaction 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 transactions transactionReferenceId Displays the transaction reference identifier under the respective case on which the API was called.

Response JSON Sample

This section contains a response JSON sample for when transactions removal from 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": "Transactions removal was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Transactions removal was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"transactions": [
{
"MESSAGE": "Transaction removed successfully.",
"STATUS": "SUCCESS",
"transactionReferenceId": "BOTRXNCSTLOSSSEVHH004"
},
{
"MESSAGE": "Transaction removed successfully.",
"STATUS": "SUCCESS",
"transactionReferenceId": "FOTFREXDBTCRDPRCH-068"
}
]
}
]
}