| 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
{
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}