| POST | /galaxy/sendmessage | Sends a push message to users, notifying them of a message in the app. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class PostMessage : ILogRequest, IHasApiKey
{
/**
* The type of message being sent.
*/
@ApiMember(DataType="MessageType", Description="The type of message being sent.", IsRequired=true)
var Type:MessageType? = null
/**
* The subject of the message
*/
@ApiMember(DataType="string", Description="The subject of the message", IsRequired=true)
var Subject:String? = null
/**
* The content of the message
*/
@ApiMember(DataType="string", Description="The content of the message", IsRequired=true)
var Content:String? = null
/**
* The recipients who will be receiving the message
*/
@ApiMember(Description="The recipients who will be receiving the message", IsRequired=true)
var Recipients:ArrayList<UserDetails> = ArrayList<UserDetails>()
/**
* The API Key required for authentication
*/
@ApiMember(Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
/**
* If set, the message will be displayed in the user's inbox in the app. Otherwise will just be a push notification.
*/
@ApiMember(Description="If set, the message will be displayed in the user's inbox in the app. Otherwise will just be a push notification.", IsRequired=true)
var ShowInInbox:Boolean? = null
}
@Flags()
enum class MessageType(val value:Int)
{
@SerializedName("1") Info(1),
@SerializedName("2") Marketing(2),
@SerializedName("3") Policy(3),
@SerializedName("4") Announcement(4),
@SerializedName("5") General(5),
@SerializedName("6") Claim(6),
}
open class UserDetails
{
var IdNumber:String? = null
var GalaxyCompanyId:Int? = null
}
open class PostMessageResponse : ApiServiceResponse()
{
}
open class ApiServiceResponse : IServiceResponse
{
var Description:String? = null
var Heading:String? = null
var WasSuccessful:Boolean? = null
var ModelState:Object? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /galaxy/sendmessage HTTP/1.1
Host: galaxymobile.api.dev.86degrees.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Type":1,"Subject":"String","Content":"String","Recipients":[{"IdNumber":"String","GalaxyCompanyId":0}],"ApiKey":"String","ShowInInbox":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}