| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /newsletter/templates/{Id} | Update a company newsletter template. | Update a 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 UpdateNewsletterTemplate 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 id.
*/
@ApiMember(Description="The newsletter template id.", IsRequired=true, ParameterType="path")
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 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 UpdateNewsletterTemplate setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public UpdateNewsletterTemplate setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public UpdateNewsletterTemplate setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public UpdateNewsletterTemplate setBody(String value) { this.Body = value; return this; }
public String getImageUrl() { return ImageUrl; }
public UpdateNewsletterTemplate setImageUrl(String value) { this.ImageUrl = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public UpdateNewsletterTemplate setSendMethodId(Integer value) { this.SendMethodId = value; return this; }
public Integer getEmailTemplateId() { return EmailTemplateId; }
public UpdateNewsletterTemplate 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 UpdateNewsletterTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /newsletter/templates/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
Heading: String,
Body: String,
ImageUrl: String,
SendMethodId: 0,
EmailTemplateId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Heading: String,
Body: String,
EmailTemplateId: 0,
SendMethodId: 0,
ImageUrl: String,
SendMethodInformation:
{
Id: 0,
Name: String,
Description: String
},
EmailTemplateInformation:
{
Id: 0,
Name: String,
Description: String,
Body: String
}
}