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.


export class ApiServiceResponse implements IServiceResponse
{
    public Description: string;
    public Heading: string;
    public WasSuccessful: boolean;
    public ModelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class PostMessageResponse extends ApiServiceResponse
{

    public constructor(init?: Partial<PostMessageResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export enum MessageType
{
    Info = 1,
    Marketing = 2,
    Policy = 3,
    Announcement = 4,
    General = 5,
    Claim = 6,
}

export class UserDetails
{
    public IdNumber: string;
    public GalaxyCompanyId: number;

    public constructor(init?: Partial<UserDetails>) { (Object as any).assign(this, init); }
}

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

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

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

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

    /**
    * The API Key required for authentication
    */
    // @ApiMember(Description="The API Key required for authentication", IsRequired=true)
    public 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 ShowInInbox: boolean;

    public constructor(init?: Partial<PostMessage>) { (Object as any).assign(this, init); }
}

TypeScript PostMessage DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ModelState: {}
}