| POST | /galaxy/sendmessage | Sends a push message to users, notifying them of a message in the app. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class PostMessage implements ILogRequest, IHasApiKey
{
/**
* The type of message being sent.
*/
@ApiMember(DataType="MessageType", Description="The type of message being sent.", IsRequired=true)
public MessageType Type = null;
/**
* The subject of the message
*/
@ApiMember(DataType="string", Description="The subject of the message", IsRequired=true)
public String Subject = null;
/**
* The content of the message
*/
@ApiMember(DataType="string", Description="The content of the message", IsRequired=true)
public String Content = null;
/**
* The recipients who will be receiving the message
*/
@ApiMember(Description="The recipients who will be receiving the message", IsRequired=true)
public ArrayList<UserDetails> Recipients = null;
/**
* The API Key required for authentication
*/
@ApiMember(Description="The API Key required for authentication", IsRequired=true)
public String ApiKey = null;
/**
* 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 Boolean ShowInInbox = null;
public MessageType getType() { return Type; }
public PostMessage setType(MessageType value) { this.Type = value; return this; }
public String getSubject() { return Subject; }
public PostMessage setSubject(String value) { this.Subject = value; return this; }
public String getContent() { return Content; }
public PostMessage setContent(String value) { this.Content = value; return this; }
public ArrayList<UserDetails> getRecipients() { return Recipients; }
public PostMessage setRecipients(ArrayList<UserDetails> value) { this.Recipients = value; return this; }
public String getApiKey() { return ApiKey; }
public PostMessage setApiKey(String value) { this.ApiKey = value; return this; }
public Boolean isShowInInbox() { return ShowInInbox; }
public PostMessage setShowInInbox(Boolean value) { this.ShowInInbox = value; return this; }
}
@Flags()
public static enum MessageType
{
@SerializedName("1") Info(1),
@SerializedName("2") Marketing(2),
@SerializedName("3") Policy(3),
@SerializedName("4") Announcement(4),
@SerializedName("5") General(5),
@SerializedName("6") Claim(6);
private final int value;
MessageType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class UserDetails
{
public String IdNumber = null;
public Integer GalaxyCompanyId = null;
public String getIdNumber() { return IdNumber; }
public UserDetails setIdNumber(String value) { this.IdNumber = value; return this; }
public Integer getGalaxyCompanyId() { return GalaxyCompanyId; }
public UserDetails setGalaxyCompanyId(Integer value) { this.GalaxyCompanyId = value; return this; }
}
public static class PostMessageResponse extends ApiServiceResponse
{
}
public static class ApiServiceResponse implements IServiceResponse
{
public String Description = null;
public String Heading = null;
public Boolean WasSuccessful = null;
public Object ModelState = null;
public String getDescription() { return Description; }
public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
public String getHeading() { return Heading; }
public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
public Boolean isWasSuccessful() { return WasSuccessful; }
public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
public Object getModelState() { return ModelState; }
public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>