POST api/notification/toast?personIds={personIds}
Will put a toast on a list of negotiators desktops
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| personIds |
comma separated parameter list of person ids to send the notification to |
string |
Required |
Body Parameters
notification data contract
UserNotification| Name | Description | Type | Additional information |
|---|---|---|---|
| NotificationTitle | string |
None. |
|
| MessageContent | string |
None. |
|
| AssociatedLinks | Collection of SecurityAwareLink |
None. |
|
| JobReference | globally unique identifier |
None. |
|
| JobStatusText | string |
None. |
|
| JobStatus | string |
None. |
|
| JobPercentageCompleted | integer |
None. |
|
| MessageType | string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"NotificationTitle": "sample string 1",
"MessageContent": "sample string 2",
"AssociatedLinks": [
{
"LinkText": "sample string 1",
"LinkAddress": "sample string 2",
"RequiresAuthentication": true,
"OpenInNewTab": true
},
{
"LinkText": "sample string 1",
"LinkAddress": "sample string 2",
"RequiresAuthentication": true,
"OpenInNewTab": true
}
],
"JobReference": "d90dbbaf-fd45-4f4d-81ae-ed3feba2e716",
"JobStatusText": "sample string 4",
"JobStatus": "sample string 5",
"JobPercentageCompleted": 6,
"MessageType": "Dezrez.Core.DataContracts.External.NotificationService.UserNotification.UserNotification"
}
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |