Show case details¶
Use the /cases/{caseId} to retrieve all details of a specific non-executable service request, e.g., Billing complaints, Bin complaints etc.To retrieve the summary of all the cases on your account see, cases api
URI¶
/api/v1/customers/{customerId}/cases/{caseId}
Headers¶
| Parameter | Mandatory | Data Type | Allowed Values | Description |
|---|---|---|---|---|
| Request-Tracking-Id | Y | String | Unique Identifier for each request | |
| Authorization | Y | String | Access token | |
| ClientId | Y | String | Will be provided by WM | |
| Accept | N | String | application/json or application/xml | Default is application/json |
Request Parameters¶
Pass the following parameters in the request.
| Parameter | Mandatory | Data Type | Type | Description |
|---|---|---|---|---|
| customerId | Y | Number | path | Unique Customer Identifier |
| caseId | Y | Number | query | Unique ID assigned to a case |
Response Fields¶
| Parameter | Data Type | Description |
|---|---|---|
| request_tracking_id | String | Unique identifier for each request |
| cases | Object | The cases details |
| description | String | Description of the case |
| category | String | Case category |
| category_description | String | Category description |
| sub_category | String | Case sub category |
| sub_category_description | String | Sub Category description |
| requested_date_time | String | Case Creation date and time |
| due_date_time | String | Due date to serve the request |
| assigned_role | String | Assignee Role |
| assigned_to | String | Assignee Identifier |
| status | String | Case status(OPEN,CLOSED) |
| status_reason_code | String | Reason code for status |
| status_reason_description | String | Reason description for status |
| source | String | Source of case creation |
| adjustment_total_amount | Number | Amount adjusted by CSR agent for adjustment case |
| notes | Object | The customer notes |
| comment | String | Notes about the case |
| requestor | Object | Case requestor details |
| name | String | Name of the requestor |
| phone | Number | Phone number of the requestor |
| String | Email address of the requestor | |
| adjustments | Object | Case adjustment details - For an adjustment case only |
| description | String | Description of case adjustment |
| amount | Number | Amount adjusted |
| date_time | String | Adjustment date and time |
| reason_code | String | Adjustment reason code |
| reason_code_description | String | Adjustment reason code description |
| invoice_number | Number | Invoice number |
| transaction_code | String | Transaction code |
| transaction_description | String | Transaction description |
| service_code | String | Service code |
| service_description | String | Service description |
| reference_info | Object | Case reference information |
| case_id | Number | Unique ID assigned to a case |
| invoice_number | Number | Invoice number |
| transaction_code | String | Transaction code |
| transaction_description | String | Transaction description |
| service_code | String | Service code |
| service_description | String | Service description |
Tip
For information about how to test, see How To Test
Sample Request¶
http://api.wm.com/v1/customers/123456789/cases/679
Sample Response¶
{ "request_tracking_id": "123", "cases": { "description": "MISAPPLY", "category": "ADJ", "category_description": "null", "sub_category": "MDB", "sub_category_description": "null", "requested_date_time": "2015-12-03 17:36:25.0", "due_date_time": "2015-12-08 17:36:00.0", "assigned_role": "APPROVER1", "assigned_to": "DBELL", "status": "CLOSED", "status_reason_code": "APR", "status_reason_description": "null", "source": "PHONE", "adjustment_total_amount": "7656", "notes": [{ "comment": "APPROVED" }, { "comment": "12/04/2015 05:58:50 DBELL" }, { "comment": "NEED FUNDS MOVED DID NOT POST RIGHT - PER REMIT FROM AP JACKIE" }, { "comment": "12/03/2015 17:36:26 SSCHROFF" }], "requestor": { "name": "JACKIE", "phone": "8663631033" }, "adjustments": [ { "description": "To 450-1474773", "amount": "7656", "date_time": "2015-12-04 00:00:00.0", "reason_code": "", "reason_code_description": "null", "invoice_number": "103801", "transaction_code": "MSD", "transaction_description": "MISAPPLIED DEBIT", "service_code": "MSD", "service_description": "MISAPPLIED DEBIT", "reference_info": { "case_id": "687", "invoice_number": "103975", "transaction_code": "MSC", "transaction_description": "MISAPPLIED CREDIT", "service_code": "", "service_description": "null" } } ] }}