BokaMera.API.Host

<back to all web services

SendEmail

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
POST/messages/sendemailSend email to any email recipientSend email to any email recipient.
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 SendEmail 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.", ParameterType="path")
        public UUID CompanyId = null;

        /**
        * The message receiver email.
        */
        @ApiMember(Description="The message receiver email.")
        public String Receiver = null;

        /**
        * Message Title.
        */
        @ApiMember(Description="Message Title.")
        public String MessageTitle = null;

        /**
        * Message Body.
        */
        @ApiMember(Description="Message Body.")
        public String MessageBody = null;

        /**
        * When the message will be sent.
        */
        @ApiMember(Description="When the message will be sent.")
        public Date ToSendDate = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SendEmail setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getReceiver() { return Receiver; }
        public SendEmail setReceiver(String value) { this.Receiver = value; return this; }
        public String getMessageTitle() { return MessageTitle; }
        public SendEmail setMessageTitle(String value) { this.MessageTitle = value; return this; }
        public String getMessageBody() { return MessageBody; }
        public SendEmail setMessageBody(String value) { this.MessageBody = value; return this; }
        public Date getToSendDate() { return ToSendDate; }
        public SendEmail setToSendDate(Date value) { this.ToSendDate = 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 SendEmail DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /messages/sendemail HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Receiver":"String","MessageTitle":"String","MessageBody":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}