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 Foundation
import ServiceStack

public class PostMessage : ILogRequest, IHasApiKey, Codable
{
    /**
    * The type of message being sent.
    */
    // @ApiMember(DataType="MessageType", Description="The type of message being sent.", IsRequired=true)
    public var type:MessageType

    /**
    * The subject of the message
    */
    // @ApiMember(DataType="string", Description="The subject of the message", IsRequired=true)
    public var subject:String

    /**
    * The content of the message
    */
    // @ApiMember(DataType="string", Description="The content of the message", IsRequired=true)
    public var content:String

    /**
    * The recipients who will be receiving the message
    */
    // @ApiMember(Description="The recipients who will be receiving the message", IsRequired=true)
    public var recipients:[UserDetails] = []

    /**
    * The API Key required for authentication
    */
    // @ApiMember(Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * 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)
    public var showInInbox:Bool

    required public init(){}
}

// @Flags()
public enum MessageType : Int, Codable
{
    case Info = 1
    case Marketing = 2
    case Policy = 3
    case Announcement = 4
    case General = 5
    case Claim = 6
}

public class UserDetails : Codable
{
    public var idNumber:String
    public var galaxyCompanyId:Int

    required public init(){}
}

public class PostMessageResponse : ApiServiceResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

Swift 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>