BokaMera.API.Host

<back to all web services

TestSendNewsLetter

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/newsletter/templates/testTest 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; }
    }

}

Java TestSendNewsLetter DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Receiver":"String","Id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Receiver":"String","MessageTitle":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"SendMethodId":0}