| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates | Create a new company newsletter template. | Create a new company newsletter template. |
|---|
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 CreateNewsletterTemplate 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 newsletter template heading.
*/
@ApiMember(Description="The newsletter template heading.")
public String Heading = null;
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.")
public String Body = null;
/**
* The newsletter template image url.
*/
@ApiMember(Description="The newsletter template image url.")
public String ImageUrl = null;
/**
* The newsletter template send method (1=email, 2=sms).
*/
@ApiMember(Description="The newsletter template send method (1=email, 2=sms).")
public Integer SendMethodId = null;
/**
* The email template id. Get valid email templates from GET /newsletter/emailtemplates
*/
@ApiMember(Description="The email template id. Get valid email templates from GET /newsletter/emailtemplates")
public Integer EmailTemplateId = null;
public UUID getCompanyId() { return CompanyId; }
public CreateNewsletterTemplate setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getHeading() { return Heading; }
public CreateNewsletterTemplate setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public CreateNewsletterTemplate setBody(String value) { this.Body = value; return this; }
public String getImageUrl() { return ImageUrl; }
public CreateNewsletterTemplate setImageUrl(String value) { this.ImageUrl = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public CreateNewsletterTemplate setSendMethodId(Integer value) { this.SendMethodId = value; return this; }
public Integer getEmailTemplateId() { return EmailTemplateId; }
public CreateNewsletterTemplate setEmailTemplateId(Integer value) { this.EmailTemplateId = value; return this; }
}
public static class NewsletterTemplatesQueryResponse
{
/**
* The newsletter template id
*/
@ApiMember(Description="The newsletter template id")
public Integer Id = null;
/**
* The newsletter template heading.
*/
@ApiMember(Description="The newsletter template heading.")
public String Heading = null;
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.")
public String Body = null;
/**
* The email template the newsletter uses.
*/
@ApiMember(Description="The email template the newsletter uses.")
public Integer EmailTemplateId = null;
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
public Integer SendMethodId = null;
/**
* The newsletter template image url.
*/
@ApiMember(Description="The newsletter template image url.")
public String ImageUrl = null;
/**
* The newsletter created date.
*/
@ApiMember(Description="The newsletter created date.")
public Date Created = null;
/**
* Send method information.
*/
@ApiMember(Description="Send method information.")
public NewsletterSendMethodQueryResponse SendMethodInformation = null;
/**
* Email template information.
*/
@ApiMember(Description="Email template information.")
public NewsletterEmailTemplatesQueryResponse EmailTemplateInformation = null;
public Integer getId() { return Id; }
public NewsletterTemplatesQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public NewsletterTemplatesQueryResponse setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public NewsletterTemplatesQueryResponse setBody(String value) { this.Body = value; return this; }
public Integer getEmailTemplateId() { return EmailTemplateId; }
public NewsletterTemplatesQueryResponse setEmailTemplateId(Integer value) { this.EmailTemplateId = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public NewsletterTemplatesQueryResponse setSendMethodId(Integer value) { this.SendMethodId = value; return this; }
public String getImageUrl() { return ImageUrl; }
public NewsletterTemplatesQueryResponse setImageUrl(String value) { this.ImageUrl = value; return this; }
public Date getCreated() { return Created; }
public NewsletterTemplatesQueryResponse setCreated(Date value) { this.Created = value; return this; }
public NewsletterSendMethodQueryResponse getSendMethodInformation() { return SendMethodInformation; }
public NewsletterTemplatesQueryResponse setSendMethodInformation(NewsletterSendMethodQueryResponse value) { this.SendMethodInformation = value; return this; }
public NewsletterEmailTemplatesQueryResponse getEmailTemplateInformation() { return EmailTemplateInformation; }
public NewsletterTemplatesQueryResponse setEmailTemplateInformation(NewsletterEmailTemplatesQueryResponse value) { this.EmailTemplateInformation = value; return this; }
}
public static class NewsletterSendMethodQueryResponse
{
/**
* The send method id
*/
@ApiMember(Description="The send method id")
public Integer Id = null;
/**
* The send method name.
*/
@ApiMember(Description="The send method name.")
public String Name = null;
/**
* The send method description.
*/
@ApiMember(Description="The send method description.")
public String Description = null;
public Integer getId() { return Id; }
public NewsletterSendMethodQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public NewsletterSendMethodQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public NewsletterSendMethodQueryResponse setDescription(String value) { this.Description = value; return this; }
}
public static class NewsletterEmailTemplatesQueryResponse
{
/**
* The email template id
*/
@ApiMember(Description="The email template id")
public Integer Id = null;
/**
* The email template name.
*/
@ApiMember(Description="The email template name.")
public String Name = null;
/**
* The email template description.
*/
@ApiMember(Description="The email template description.")
public String Description = null;
/**
* The email template html content.
*/
@ApiMember(Description="The email template html content.")
public String Body = null;
public Integer getId() { return Id; }
public NewsletterEmailTemplatesQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public NewsletterEmailTemplatesQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public NewsletterEmailTemplatesQueryResponse setDescription(String value) { this.Description = value; return this; }
public String getBody() { return Body; }
public NewsletterEmailTemplatesQueryResponse setBody(String value) { this.Body = value; return this; }
}
}
Java CreateNewsletterTemplate DTOs
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 HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateNewsletterTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<EmailTemplateId>0</EmailTemplateId>
<Heading>String</Heading>
<ImageUrl>String</ImageUrl>
<SendMethodId>0</SendMethodId>
</CreateNewsletterTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NewsletterTemplatesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<Created>0001-01-01T00:00:00</Created>
<EmailTemplateId>0</EmailTemplateId>
<EmailTemplateInformation>
<Body>String</Body>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</EmailTemplateInformation>
<Heading>String</Heading>
<Id>0</Id>
<ImageUrl>String</ImageUrl>
<SendMethodId>0</SendMethodId>
<SendMethodInformation>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</SendMethodInformation>
</NewsletterTemplatesQueryResponse>