POST api/Notification

Request Information

URI Parameters

None.

Body Parameters

KiviCOM.API.Business.Users.Notifications.NotificationRequestInfo
NameDescriptionTypeAdditional information
DeviceId

string

None.

PhoneOs

string

None.

NotificationOptions

Collection of KiviCOM.API.Business.Users.Notifications.NotificationInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "DeviceId": "sample string 1",
  "PhoneOs": "sample string 2",
  "NotificationOptions": [
    {
      "NotificationType": "sample string 1",
      "Subscribe": true,
      "PhoneOs": "sample string 3",
      "DeviceId": "sample string 4"
    },
    {
      "NotificationType": "sample string 1",
      "Subscribe": true,
      "PhoneOs": "sample string 3",
      "DeviceId": "sample string 4"
    }
  ]
}

text/xml

Sample:
<NotificationRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KiviCOM.API.Business.Users.Notifications">
  <DeviceId>sample string 1</DeviceId>
  <NotificationOptions>
    <NotificationInfo>
      <DeviceId>sample string 4</DeviceId>
      <NotificationType>sample string 1</NotificationType>
      <PhoneOs>sample string 3</PhoneOs>
      <Subscribe>true</Subscribe>
    </NotificationInfo>
    <NotificationInfo>
      <DeviceId>sample string 4</DeviceId>
      <NotificationType>sample string 1</NotificationType>
      <PhoneOs>sample string 3</PhoneOs>
      <Subscribe>true</Subscribe>
    </NotificationInfo>
  </NotificationOptions>
  <PhoneOs>sample string 2</PhoneOs>
</NotificationRequestInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

KiviCOM.API.Business.Users.Notifications.NotificationResponseInfo
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "Message": "sample string 2"
}

text/xml

Sample:
<NotificationResponseInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KiviCOM.API.Business.Users.Notifications">
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
</NotificationResponseInfo>