| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class NewsletterTemplatesQuery extends QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse> 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.")
public Integer Id = null;
/**
* If you want to include the message send method information
*/
@ApiMember(DataType="boolean", Description="If you want to include the message send method information", ParameterType="query")
public Boolean IncludeSendMethodInformation = null;
/**
* If you want to include the email template information
*/
@ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")
public Boolean IncludeEmailTemplateInformation = null;
public UUID getCompanyId() { return CompanyId; }
public NewsletterTemplatesQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public NewsletterTemplatesQuery setId(Integer value) { this.Id = value; return this; }
public Boolean isIncludeSendMethodInformation() { return IncludeSendMethodInformation; }
public NewsletterTemplatesQuery setIncludeSendMethodInformation(Boolean value) { this.IncludeSendMethodInformation = value; return this; }
public Boolean isIncludeEmailTemplateInformation() { return IncludeEmailTemplateInformation; }
public NewsletterTemplatesQuery setIncludeEmailTemplateInformation(Boolean value) { this.IncludeEmailTemplateInformation = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class NewsletterTemplate extends BaseModel
{
public SendMethod SendMethod = null;
public EmailTemplate EmailTemplate = null;
@Required()
public UUID CompanyId = null;
public Integer Id = null;
@Required()
public String Heading = null;
@Required()
public String Body = null;
public String ImageUrl = null;
@Required()
public Integer SendMethodId = null;
public Integer EmailTemplateId = null;
@Required()
public Date Created = null;
public Date ModifiedDate = null;
public SendMethod getSendMethod() { return SendMethod; }
public NewsletterTemplate setSendMethod(SendMethod value) { this.SendMethod = value; return this; }
public EmailTemplate getEmailTemplate() { return EmailTemplate; }
public NewsletterTemplate setEmailTemplate(EmailTemplate value) { this.EmailTemplate = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public NewsletterTemplate setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public NewsletterTemplate setId(Integer value) { this.Id = value; return this; }
public String getHeading() { return Heading; }
public NewsletterTemplate setHeading(String value) { this.Heading = value; return this; }
public String getBody() { return Body; }
public NewsletterTemplate setBody(String value) { this.Body = value; return this; }
public String getImageUrl() { return ImageUrl; }
public NewsletterTemplate setImageUrl(String value) { this.ImageUrl = value; return this; }
public Integer getSendMethodId() { return SendMethodId; }
public NewsletterTemplate setSendMethodId(Integer value) { this.SendMethodId = value; return this; }
public Integer getEmailTemplateId() { return EmailTemplateId; }
public NewsletterTemplate setEmailTemplateId(Integer value) { this.EmailTemplateId = value; return this; }
public Date getCreated() { return Created; }
public NewsletterTemplate setCreated(Date value) { this.Created = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public NewsletterTemplate setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class BaseModel
{
}
public static class SendMethod extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String Description = null;
public Date ModifiedDate = null;
public Integer Id = null;
public String getName() { return Name; }
public SendMethod setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public SendMethod setDescription(String value) { this.Description = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public SendMethod setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Integer getId() { return Id; }
public SendMethod setId(Integer value) { this.Id = value; return this; }
}
public static class EmailTemplate extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String Description = null;
@Required()
public String Body = null;
@Required()
public Integer Type = null;
public Date ModifiedDate = null;
public Integer Id = null;
public String getName() { return Name; }
public EmailTemplate setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public EmailTemplate setDescription(String value) { this.Description = value; return this; }
public String getBody() { return Body; }
public EmailTemplate setBody(String value) { this.Body = value; return this; }
public Integer getType() { return Type; }
public EmailTemplate setType(Integer value) { this.Type = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public EmailTemplate setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Integer getId() { return Id; }
public EmailTemplate setId(Integer value) { this.Id = 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; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
Java NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/templates HTTP/1.1 Host: api.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"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"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}