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.

namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type PostMessageResponse() = 
        inherit ApiServiceResponse()

    [<Flags>]
    type MessageType =
        | Info = 1
        | Marketing = 2
        | Policy = 3
        | Announcement = 4
        | General = 5
        | Claim = 6

    [<AllowNullLiteral>]
    type UserDetails() = 
        member val IdNumber:String = null with get,set
        member val GalaxyCompanyId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PostMessage() = 
        ///<summary>
        ///The type of message being sent.
        ///</summary>
        [<ApiMember(DataType="MessageType", Description="The type of message being sent.", IsRequired=true)>]
        member val Type:MessageType = new MessageType() with get,set

        ///<summary>
        ///The subject of the message
        ///</summary>
        [<ApiMember(DataType="string", Description="The subject of the message", IsRequired=true)>]
        member val Subject:String = null with get,set

        ///<summary>
        ///The content of the message
        ///</summary>
        [<ApiMember(DataType="string", Description="The content of the message", IsRequired=true)>]
        member val Content:String = null with get,set

        ///<summary>
        ///The recipients who will be receiving the message
        ///</summary>
        [<ApiMember(Description="The recipients who will be receiving the message", IsRequired=true)>]
        member val Recipients:ResizeArray<UserDetails> = new ResizeArray<UserDetails>() with get,set

        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///If set, the message will be displayed in the user's inbox in the app. Otherwise will just be a push notification.
        ///</summary>
        [<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)>]
        member val ShowInInbox:Boolean = new Boolean() with get,set

F# 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>