| POST | /customers/activities |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | body | string | Yes | The customer to link the activity to |
| Description | body | string | Yes | Information about activity |
| AdditionalInformation | body | string | No | Used to capture technical information during order flow process |
| StartDate | body | DateTime? | No | Start date for activity, if not provided today's datetime would be used. For category task, time component would be removed |
| DueDate | body | DateTime? | No | End date for activity, if not provided today's datetime would be used. For category task, time component would be removed |
| Category | body | ActivityCategory? | No | Category, Default value is 'Event'Allowable Values
|
| Purpose | body | string | No | Purpose |
| Priority | body | ActivityPriority? | No | |
| Type | body | string | No | Activity Type (obsolete). Type should match with the Activity Action table in AX |
| ActionType | body | string | Yes | Activity Action Type. Type should match with the Activity Action table in AX |
| ActivityType | body | string | No | Activity Type, if not provided it will be set to 'Tasks'. Current values supported are 'Tasks' and 'Comms' |
| Interaction | body | string | No | Interaction, Current values supported are 'Email', 'Inbound' and 'Outbound' |
| UserGroup | body | string | No | Group assigned as responsible for actioning activity.If not specified, default value from Activity Action table will be taken |
| ContactInformation | body | string | No | ContactInformation |
| Dispatched | body | bool | No | Dispatched. |
| RequestReference | body | RequestReference | No | Attribution values associated to the request if any |
| Name | Value |
|---|---|
| Appointment | 1 |
| Task | 2 |
| Action | 3 |
| Event | 4 |
| High |
| Normal |
| Low |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | form | string | No | |
| RetailChannelId | form | string | Yes | |
| ReferenceId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ActivityId | form | string | No | |
| CustomerId | form | string | No | |
| OrderId | form | string | No | |
| Description | form | string | No | |
| AdditionalInformation | form | string | No | |
| StartDate | form | DateTime | No | |
| DueDate | form | DateTime | No | |
| Category | form | ActivityCategory? | No | |
| Purpose | form | string | No | |
| ContactInformation | form | string | No | |
| Type | form | string | No | |
| ActionType | form | string | No | |
| ActivityType | form | string | No | |
| UserGroup | form | string | No | |
| Dispatched | form | string | No | |
| DispatchDateTime | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers/activities HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"customerId":"String","description":"String","additionalInformation":"String","startDate":"0001-01-01T00:00:00.0000000","dueDate":"0001-01-01T00:00:00.0000000","category":"0","purpose":"String","priority":"High","type":"String","actionType":"String","activityType":"String","interaction":"String","userGroup":"String","contactInformation":"String","dispatched":false,"requestReference":{"campaignId":"String","retailChannelId":"String","referenceId":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"activityId":"String","customerId":"String","orderId":"String","description":"String","additionalInformation":"String","startDate":"0001-01-01T00:00:00.0000000","dueDate":"0001-01-01T00:00:00.0000000","category":"0","purpose":"String","contactInformation":"String","type":"String","actionType":"String","activityType":"String","userGroup":"String","dispatched":"String","dispatchDateTime":"0001-01-01T00:00:00.0000000"}