4.12 Remove Account from Case
This service will allow removal of accounts from an existing case.
The following topics explain how to remove accounts from 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/removeAccount
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-23 Request Parameter Details
| First Level | Second Level | Details |
|---|---|---|
| caseId | - | This accepts the case internal identifier. |
| accounts | accountId | This accepts the account internal identifier. |
Request JSON Sample
This section contains a request JSON sample to remove account from an existing case. It will accept multiple caseIds and accounts information to be removed from the case. The entries in this sample are only for reference purposes.
[
{
"caseId": "CA100",
"accounts": [
{
"accountId": "ACCT-123"
}
]
}
]Response Parameters
The following table describes the details of response parameters for a
JSON Sample when account removal from an existing case is successful.
Table 4-24 Parameter Details
| First Level | Second Level | Third Level | Details |
|---|---|---|---|
| MESSAGE | - | - | Displays the response message from the API. |
| STATUS | - | - | Displays the 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. |
| 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 | accounts | MESSAGE | Displays the response message from the API for the respective account under the respective case. |
| RESULTARRAY | accounts | STATUS | Displays the status of the API call for the respective account 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 | accounts | accountId | Displays the account internal identifier under the respective case on which the API was called. |
Response JSON Sample
This section contains a response JSON sample for when account 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": "Accounts removal was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Accounts removal was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"accounts": [
{
"MESSAGE": "Account removed successfully.",
"STATUS": "SUCCESS",
"accountId": "ACCT-5"
},
{
"MESSAGE": "Account removed successfully.",
"STATUS": "SUCCESS",
"accountId": "ACCT-6"
}
]
}
]
}