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.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using BusinessLogic.Entities;
using CommonService.Api.Models.Base;

namespace BusinessLogic.Entities
{
    [Flags]
    public enum MessageType
    {
        Info = 1,
        Marketing = 2,
        Policy = 3,
        Announcement = 4,
        General = 5,
        Claim = 6,
    }

    public partial class UserDetails
    {
        public virtual string IdNumber { get; set; }
        public virtual int GalaxyCompanyId { get; set; }
    }

}

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class PostMessage
        : ILogRequest, IHasApiKey
    {
        public PostMessage()
        {
            Recipients = new List<UserDetails>{};
        }

        ///<summary>
        ///The type of message being sent.
        ///</summary>
        [ApiMember(DataType="MessageType", Description="The type of message being sent.", IsRequired=true)]
        public virtual MessageType Type { get; set; }

        ///<summary>
        ///The subject of the message
        ///</summary>
        [ApiMember(DataType="string", Description="The subject of the message", IsRequired=true)]
        public virtual string Subject { get; set; }

        ///<summary>
        ///The content of the message
        ///</summary>
        [ApiMember(DataType="string", Description="The content of the message", IsRequired=true)]
        public virtual string Content { get; set; }

        ///<summary>
        ///The recipients who will be receiving the message
        ///</summary>
        [ApiMember(Description="The recipients who will be receiving the message", IsRequired=true)]
        public virtual List<UserDetails> Recipients { get; set; }

        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { 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)]
        public virtual bool ShowInInbox { get; set; }
    }

    public partial class PostMessageResponse
        : ApiServiceResponse
    {
    }

}

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