GalaxyMobile App API

PostMessage

The following routes are available for this service:
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
}

Kotlin PostMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PostMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey>String</ApiKey>
  <Content>String</Content>
  <Recipients xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
    <d2p1:UserDetails>
      <d2p1:GalaxyCompanyId>0</d2p1:GalaxyCompanyId>
      <d2p1:IdNumber>String</d2p1:IdNumber>
    </d2p1:UserDetails>
  </Recipients>
  <ShowInInbox>false</ShowInInbox>
  <Subject>String</Subject>
  <Type>Info</Type>
</PostMessage>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
</PostMessageResponse>