POST api/people/sendnotification
Sends a user notification to the specified user Processes this people API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The send notification to person command data contract supplied with the request.
SendNotificationToPersonCommandDataContract| 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. |
| Id |
The unique identifier of this resource. |
integer |
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
}
],
"Id": 3
}
Response Information
Resource Description
No Content
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. |