BokaMera.API.Host

<back to all web services

NewsletterResendMessage

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/newsletter/log/{Id}/resendResend a message from the logResend a message from the log to the recepient.
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 NewsletterResendMessage 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;

        /**
        * Newsletter message Id
        */
        @ApiMember(DataType="int", Description="Newsletter message Id", ParameterType="path")
        public Integer Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public NewsletterResendMessage setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public NewsletterResendMessage 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 NewsletterResendMessage DTOs

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

HTTP + XML

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

PUT /newsletter/log/{Id}/resend HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NewsletterResendMessage 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>
</NewsletterResendMessage>
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>