| GET | /customers/{CustomerId}/ContactPreferences |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | string | Yes | The customer identifier |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | form | string | No | |
| Category | form | List<Category> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Description | form | string | No | |
| GameType | form | List<GameType> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Description | form | string | No | |
| CommunicationMethod | form | List<CommunicationMethod> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Entity | form | string | No | |
| Type | form | string | No | |
| Purpose | form | string | No | |
| Description | form | string | No | |
| Enabled | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{CustomerId}/ContactPreferences HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
customerId: String,
category:
[
{
id: String,
description: String,
gameType:
[
{
id: String,
description: String,
communicationMethod:
[
{
entity: String,
type: String,
purpose: String,
description: String,
enabled: False
}
]
}
]
}
]
}