POST api/notification/toast?personIds={personIds}

Will put a toast on a list of negotiators desktops Processes this notification API request. The parameter and response sections describe the data exchanged with the API.

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	The notification title value.	string	None.
MessageContent	The message content value.	string	None.
AssociatedLinks	The collection of associated links.	Collection of SecurityAwareLink	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
JobStatusText	The job status text value.	string	None.
JobStatus	The job status value.	string	None.
JobPercentageCompleted	The job percentage completed value.	integer	None.
MessageType	The message type value.	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": "7df379ad-0064-4455-8371-8b418c6744d2",
  "JobStatusText": "sample string 4",
  "JobStatus": "sample string 5",
  "JobPercentageCompleted": 6,
  "MessageType": "Dezrez.Core.DataContracts.External.NotificationService.UserNotification.UserNotification"
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.