POST restapi/personal/notifications/posts/v1

Send personal notifications. Current user will be set as an author of all notifications.

Request Information

URI Parameters

None.

Body Parameters

The notifications.

Itslearning.RestApi.Entities.PersonalNotificationsPostV1

Name	Description	Type	Additional information
Message	Notification message in a default locale.	string	None.
LocalizedMessages	The list of localized messages where Key - locale name by ISO 3166-1 alpha-2 and ISO 639-1 which separated by the symbol '-' (f.e. "en-GB"), Value - the notification message text in this locale.	Dictionary of string [key] and string [value]	None.
NotificationType	The any string that represents a specific type of notification.	string	None.
Object	The identifier of object to which notifcation is related. Notification belongs to one object only.	Itslearning.RestApi.Entities.TypedId	None.
Locations	List of identifiers of all locations to which notification is related. Usually notification belongs to one location, but it's possible to specify any number of locations.	Collection of Itslearning.RestApi.Entities.TypedId	None.
Url	The absolute URL that pointing to a notification related information.	string	None.
ToPersonIds	List of person identifiers to send notification to.	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "LocalizedMessages": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "NotificationType": "sample string 2",
  "Object": {
    "Type": "sample string 1",
    "Id": "sample string 2"
  },
  "Locations": [
    {
      "Type": "sample string 1",
      "Id": "sample string 2"
    },
    {
      "Type": "sample string 1",
      "Id": "sample string 2"
    }
  ],
  "Url": "sample string 3",
  "ToPersonIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<PersonalNotificationsPostV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LocalizedMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </LocalizedMessages>
  <Locations>
    <TypedId>
      <Id>sample string 2</Id>
      <Type>sample string 1</Type>
    </TypedId>
    <TypedId>
      <Id>sample string 2</Id>
      <Type>sample string 1</Type>
    </TypedId>
  </Locations>
  <Message>sample string 1</Message>
  <NotificationType>sample string 2</NotificationType>
  <Object>
    <Id>sample string 2</Id>
    <Type>sample string 1</Type>
  </Object>
  <ToPersonIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ToPersonIds>
  <Url>sample string 3</Url>
</PersonalNotificationsPostV1>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.