| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates/test | Test to send a newsletter 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 TestSendNewsLetter 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 newsletter template id.
*/
@ApiMember(Description="The newsletter template id.", IsRequired=true)
public Integer Id = null;
public UUID getCompanyId() { return CompanyId; }
public TestSendNewsLetter setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getReceiver() { return Receiver; }
public TestSendNewsLetter setReceiver(String value) { this.Receiver = value; return this; }
public Integer getId() { return Id; }
public TestSendNewsLetter setId(Integer value) { this.Id = value; return this; }
}
public static class NewsletterLogQueryResponse
{
/**
* The message log id
*/
@ApiMember(Description="The message log id")
public Integer Id = 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;
/**
* Nessage Title.
*/
@ApiMember(Description="Nessage Title.")
public String MessageTitle = null;
/**
* Nessage Body.
*/
@ApiMember(Description="Nessage 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 NewsletterLogQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getReceiver() { return Receiver; }
public NewsletterLogQueryResponse setReceiver(String value) { this.Receiver = value; return this; }
public String getMessageTitle() { return MessageTitle; }
public NewsletterLogQueryResponse setMessageTitle(String value) { this.MessageTitle = value; return this; }
public String getMessageBody() { return MessageBody; }
public NewsletterLogQueryResponse setMessageBody(String value) { this.MessageBody = value; return this; }
public Date getCreated() { return Created; }
public NewsletterLogQueryResponse setCreated(Date value) { this.Created = value; return this; }
public Date getToSendDate() { return ToSendDate; }
public NewsletterLogQueryResponse setToSendDate(Date value) { this.ToSendDate = value; return this; }
public Date getSentDate() { return SentDate; }
public NewsletterLogQueryResponse setSentDate(Date value) { this.SentDate = value; return this; }
public Boolean isSent() { return Sent; }
public NewsletterLogQueryResponse setSent(Boolean value) { this.Sent = value; return this; }
public Integer getMessageRetries() { return MessageRetries; }
public NewsletterLogQueryResponse setMessageRetries(Integer value) { this.MessageRetries = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public NewsletterLogQueryResponse setSendMethodId(Integer value) { this.SendMethodId = 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 /newsletter/templates/test HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TestSendNewsLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<Receiver>String</Receiver>
</TestSendNewsLetter>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <NewsletterLogQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Created>0001-01-01T00:00:00</Created> <Id>0</Id> <MessageBody>String</MessageBody> <MessageRetries>0</MessageRetries> <MessageTitle>String</MessageTitle> <Receiver>String</Receiver> <SendMethodId>0</SendMethodId> <Sent>false</Sent> <SentDate>0001-01-01T00:00:00</SentDate> <ToSendDate>0001-01-01T00:00:00</ToSendDate> </NewsletterLogQueryResponse>