POST api/PushNotifications/Send?customerAppID={customerAppID}&sendToAndroid={sendToAndroid}&sendToiOS={sendToiOS}

Request Information

URI Parameters

Name	Type	Additional information
customerAppID	globally unique identifier	Required
sendToAndroid	boolean	Default value is True
sendToiOS	boolean	Default value is True

Body Parameters

PushNotificationIn

Name	Type	Additional information
Title	string	None.
Message	string	None.
AndroidIcon	string	None.
iOSIcon	string	None.
iOSBadgeCount	integer	None.
ToState	string	None.
ToStateParams	string	None.
Tags	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Message": "sample string 2",
  "AndroidIcon": "sample string 3",
  "iOSIcon": "sample string 4",
  "iOSBadgeCount": 5,
  "ToState": "sample string 6",
  "ToStateParams": "sample string 7",
  "Tags": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<PushNotificationIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AndroidIcon>sample string 3</AndroidIcon>
  <Message>sample string 2</Message>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
  <Title>sample string 1</Title>
  <ToState>sample string 6</ToState>
  <ToStateParams>sample string 7</ToStateParams>
  <iOSBadgeCount>5</iOSBadgeCount>
  <iOSIcon>sample string 4</iOSIcon>
</PushNotificationIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NotificationsOutcome

Name	Description	Type	Additional information
AndroidNotificationOutcome		NotificationOutcome	None.
iOSNotificationOutcome		NotificationOutcome	None.

Response Formats

application/json, text/json

Sample:

{
  "AndroidNotificationOutcome": {
    "Success": 1,
    "Failure": 2,
    "Results": [
      {
        "ApplicationPlatform": "sample string 1",
        "PnsHandle": "sample string 2",
        "RegistrationId": "sample string 3",
        "Outcome": "sample string 4"
      },
      {
        "ApplicationPlatform": "sample string 1",
        "PnsHandle": "sample string 2",
        "RegistrationId": "sample string 3",
        "Outcome": "sample string 4"
      }
    ]
  },
  "iOSNotificationOutcome": {
    "Success": 1,
    "Failure": 2,
    "Results": [
      {
        "ApplicationPlatform": "sample string 1",
        "PnsHandle": "sample string 2",
        "RegistrationId": "sample string 3",
        "Outcome": "sample string 4"
      },
      {
        "ApplicationPlatform": "sample string 1",
        "PnsHandle": "sample string 2",
        "RegistrationId": "sample string 3",
        "Outcome": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<NotificationsOutcome xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SnapStorm.PushNotifications.Logic">
  <AndroidNotificationOutcome xmlns:d2p1="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
    <d2p1:Success>1</d2p1:Success>
    <d2p1:Failure>2</d2p1:Failure>
    <d2p1:Results>
      <d2p1:RegistrationResult>
        <d2p1:ApplicationPlatform>sample string 1</d2p1:ApplicationPlatform>
        <d2p1:PnsHandle>sample string 2</d2p1:PnsHandle>
        <d2p1:RegistrationId>sample string 3</d2p1:RegistrationId>
        <d2p1:Outcome>sample string 4</d2p1:Outcome>
      </d2p1:RegistrationResult>
      <d2p1:RegistrationResult>
        <d2p1:ApplicationPlatform>sample string 1</d2p1:ApplicationPlatform>
        <d2p1:PnsHandle>sample string 2</d2p1:PnsHandle>
        <d2p1:RegistrationId>sample string 3</d2p1:RegistrationId>
        <d2p1:Outcome>sample string 4</d2p1:Outcome>
      </d2p1:RegistrationResult>
    </d2p1:Results>
  </AndroidNotificationOutcome>
  <iOSNotificationOutcome xmlns:d2p1="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect">
    <d2p1:Success>1</d2p1:Success>
    <d2p1:Failure>2</d2p1:Failure>
    <d2p1:Results>
      <d2p1:RegistrationResult>
        <d2p1:ApplicationPlatform>sample string 1</d2p1:ApplicationPlatform>
        <d2p1:PnsHandle>sample string 2</d2p1:PnsHandle>
        <d2p1:RegistrationId>sample string 3</d2p1:RegistrationId>
        <d2p1:Outcome>sample string 4</d2p1:Outcome>
      </d2p1:RegistrationResult>
      <d2p1:RegistrationResult>
        <d2p1:ApplicationPlatform>sample string 1</d2p1:ApplicationPlatform>
        <d2p1:PnsHandle>sample string 2</d2p1:PnsHandle>
        <d2p1:RegistrationId>sample string 3</d2p1:RegistrationId>
        <d2p1:Outcome>sample string 4</d2p1:Outcome>
      </d2p1:RegistrationResult>
    </d2p1:Results>
  </iOSNotificationOutcome>
</NotificationsOutcome>