List Preferences Categories

Use /preferences/categories to retrieve all available categories like Service Exception, Service Notification for communication preferences. To get details of preferences associated with your account see, communication preferences api


URI

GET /api/v1/preferences/categories

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

Response Fields

Parameter Data Type Description
request_tracking_id String Unique identifier for each request
categories Object The Categories details
name String Preference category (Service Notification, Service Exception)
description String Category description
is_enabled String Set to "Y" or "N"
sub_categories Object The Subcategories details
name String Preference subcategory
description String Subcategory description

Tip

For information about how to test, see How To Test

Sample Request

https://api.wm.com/v1/preferences/categories

Sample Response

{    "request_tracking_id": "123",    "categories": [{            "name": "Service Notification",            "description":"Holiday sched remind, Weather svc delays, Service sched chng",                        "is_enabled":"Y",            "sub_categories": [{                "name": "HOL",                "description": "Holiday"            }]        },        {            "name": "Service Exception",            "description":"Unable to service, Road closures",                        "is_enabled":"Y",            "sub_categories": [{                "name": "NHOC",                "description": "Neg-HOC"            }]        }    ]}