POST api/Notification/Send

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	string	None.
Title	string	None.
Message	string	None.
Type	integer	None.
Items	Collection of NotificationItem	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "sample string 1",
  "Title": "sample string 2",
  "Message": "sample string 3",
  "Type": 4,
  "Items": [
    {
      "Target": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "Template": "sample string 4",
      "Params": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "Target": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "Template": "sample string 4",
      "Params": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Notification">
  <Items>
    <NotificationItem>
      <Message>sample string 3</Message>
      <Params xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Params>
      <Target>1</Target>
      <Template>sample string 4</Template>
      <Title>sample string 2</Title>
    </NotificationItem>
    <NotificationItem>
      <Message>sample string 3</Message>
      <Params xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Params>
      <Target>1</Target>
      <Template>sample string 4</Template>
      <Title>sample string 2</Title>
    </NotificationItem>
  </Items>
  <Message>sample string 3</Message>
  <Title>sample string 2</Title>
  <Type>4</Type>
  <UserId>sample string 1</UserId>
</Notification>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationResult

Name	Type	Additional information
Result	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
SystemErrorMessage	string	None.
Message	string	None.
ErrorCategory	string	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": true,
  "ErrorCode": "sample string 2",
  "ErrorMessage": "sample string 3",
  "SystemErrorMessage": "sample string 4",
  "Message": "sample string 5",
  "ErrorCategory": "sample string 6",
  "TotalCount": 7
}

application/xml, text/xml

Sample:

<OperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Model.Abstract.Common.Action">
  <ErrorCategory>sample string 6</ErrorCategory>
  <ErrorCode>sample string 2</ErrorCode>
  <ErrorMessage>sample string 3</ErrorMessage>
  <Message>sample string 5</Message>
  <Result>true</Result>
  <SystemErrorMessage>sample string 4</SystemErrorMessage>
  <TotalCount>7</TotalCount>
</OperationResult>