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 .csv suffix or ?format=csv

HTTP + 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":{}}