| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| POST | /messages/templates/test | Test to send a message to a Email or Mobile phone recepient using SMS. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class TestSendMessageTemplate implements ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.
*/
@ApiMember(Description="The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.", IsRequired=true)
public String Receiver = null;
/**
* The message template title.
*/
@ApiMember(Description="The message template title.")
public String Title = null;
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.", IsRequired=true)
public String Body = null;
/**
* The message type id. See GET /messages/templates/types
*/
@ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
public Integer TypeId = null;
/**
* Message template lanugage
*/
@ApiMember(Description="Message template lanugage", IsRequired=true)
public String Language = null;
/**
* The services that is connected to the message. If null it will be connected to all services.
*/
@ApiMember(Description="The services that is connected to the message. If null it will be connected to all services.")
public ArrayList<Integer> Services = null;
public UUID getCompanyId() { return CompanyId; }
public TestSendMessageTemplate setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getReceiver() { return Receiver; }
public TestSendMessageTemplate setReceiver(String value) { this.Receiver = value; return this; }
public String getTitle() { return Title; }
public TestSendMessageTemplate setTitle(String value) { this.Title = value; return this; }
public String getBody() { return Body; }
public TestSendMessageTemplate setBody(String value) { this.Body = value; return this; }
public Integer getTypeId() { return TypeId; }
public TestSendMessageTemplate setTypeId(Integer value) { this.TypeId = value; return this; }
public String getLanguage() { return Language; }
public TestSendMessageTemplate setLanguage(String value) { this.Language = value; return this; }
public ArrayList<Integer> getServices() { return Services; }
public TestSendMessageTemplate setServices(ArrayList<Integer> value) { this.Services = value; return this; }
}
public static class MessageLogQueryResponse
{
/**
* The message log id
*/
@ApiMember(Description="The message log id")
public Integer Id = null;
/**
* The booking id for the message (if connected to a booking).
*/
@ApiMember(Description="The booking id for the message (if connected to a booking).")
public Integer BookingId = null;
/**
* The message receiver. Either a email or a mobile phone number.
*/
@ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
public String Receiver = null;
/**
* Message Title.
*/
@ApiMember(Description="Message Title.")
public String MessageTitle = null;
/**
* Message Storage Url.
*/
@ApiMember(Description="Message Storage Url.")
public String StorageUrl = null;
/**
* Message Body.
*/
@ApiMember(Description="Message Body.")
public String MessageBody = null;
/**
* When message was created.
*/
@ApiMember(Description="When message was created.")
public Date Created = null;
/**
* When the message will be sent.
*/
@ApiMember(Description="When the message will be sent.")
public Date ToSendDate = null;
/**
* When the message was sent.
*/
@ApiMember(Description="When the message was sent.")
public Date SentDate = null;
/**
* If Message is sent
*/
@ApiMember(Description="If Message is sent")
public Boolean Sent = null;
/**
* Number of retries to send the message
*/
@ApiMember(Description="Number of retries to send the message")
public Integer MessageRetries = null;
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
public Integer SendMethodId = null;
public Integer getId() { return Id; }
public MessageLogQueryResponse setId(Integer value) { this.Id = value; return this; }
public Integer getBookingId() { return BookingId; }
public MessageLogQueryResponse setBookingId(Integer value) { this.BookingId = value; return this; }
public String getReceiver() { return Receiver; }
public MessageLogQueryResponse setReceiver(String value) { this.Receiver = value; return this; }
public String getMessageTitle() { return MessageTitle; }
public MessageLogQueryResponse setMessageTitle(String value) { this.MessageTitle = value; return this; }
public String getStorageUrl() { return StorageUrl; }
public MessageLogQueryResponse setStorageUrl(String value) { this.StorageUrl = value; return this; }
public String getMessageBody() { return MessageBody; }
public MessageLogQueryResponse setMessageBody(String value) { this.MessageBody = value; return this; }
public Date getCreated() { return Created; }
public MessageLogQueryResponse setCreated(Date value) { this.Created = value; return this; }
public Date getToSendDate() { return ToSendDate; }
public MessageLogQueryResponse setToSendDate(Date value) { this.ToSendDate = value; return this; }
public Date getSentDate() { return SentDate; }
public MessageLogQueryResponse setSentDate(Date value) { this.SentDate = value; return this; }
public Boolean isSent() { return Sent; }
public MessageLogQueryResponse setSent(Boolean value) { this.Sent = value; return this; }
public Integer getMessageRetries() { return MessageRetries; }
public MessageLogQueryResponse setMessageRetries(Integer value) { this.MessageRetries = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public MessageLogQueryResponse setSendMethodId(Integer value) { this.SendMethodId = value; return this; }
}
}
Java TestSendMessageTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /messages/templates/test HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Receiver: String,
Title: String,
Body: String,
TypeId: 0,
Language: String,
Services:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
BookingId: 0,
Receiver: String,
MessageTitle: String,
StorageUrl: String,
MessageBody: String,
SentDate: "0001-01-01T00:00:00",
Sent: False,
MessageRetries: 0,
SendMethodId: 0
}