4.10 Remove Customer from Case
This service will allow customers to be removed from an existing case.
The following topics explain how to remove Customers 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/removeCustomer
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-19 Request Parameter Details
| First Level | Second Level | Details |
|---|---|---|
| caseId | - | This accepts the case internal identifier. |
| customers | customerId | This accepts the customer internal identifier. |
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",
"customers": [
{
"customerId": "CUST123"
}
]Response Parameters
The following table describes the details of the response
parameters.
Table 4-20 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 | customers | MESSAGE | Displays the response message from the API for the respective customer under the respective case. |
| RESULTARRAY | customers | STATUS | Displays the status of the API call for the respective customer 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 | customers | customerid | Displays the customer internal identifier under the respective case on which the API was called. |
Response JSON Sample
This section contains a response JSON sample for when customer 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": "Customers removal was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Customers removal was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"customers": [
{
"MESSAGE": "Customer removed successfully.",
"STATUS": "SUCCESS",
"customerId": "CUST5"
},
{
"MESSAGE": "Customer removed successfully.",
"STATUS": "SUCCESS",
"customerId": "CUST6"
}
]
}