POST api/apps/{appShortName}/push/send

Used for sending to Florence and other apps. Send the specified message as a push notification using the tags to the given app.

Request Information

URI Parameters

Name	Description	Type	Additional information
appShortName	Short name of mobile app, e.g. florence.	string	Required

Body Parameters

Tags to send to and the message content.

PushTagEnvelope

Name	Description	Type	Additional information
Tags		Collection of PushTag	Required
Message		string	Required
Category	Classification of the message being sent. Optional. Default is empty string. Requires devices to be registered with template version 2.	PushCategoryEnum	None.
Id	Id corresponding to the message and category. Optional. Default is empty string. Requires devices to be registered with template version 2.	string	None.
Sound	For Apple devices: sound file to use for notification. Optional. The file must be embedded in the app. Default is empty string. Requires devices to be registered with template version 3.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Tags": [
    {
      "IdentifierType": 0,
      "IdentifierValue": "sample string 1"
    },
    {
      "IdentifierType": 0,
      "IdentifierValue": "sample string 1"
    }
  ],
  "Message": "sample string 1",
  "Category": 1,
  "Id": "sample string 2",
  "Sound": "sample string 3"
}

text/html

Sample:

{"Tags":[{"IdentifierType":0,"IdentifierValue":"sample string 1"},{"IdentifierType":0,"IdentifierValue":"sample string 1"}],"Message":"sample string 1","Category":1,"Id":"sample string 2","Sound":"sample string 3"}

Response Information

Resource Description

200-OK

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.