| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class EmailTemplate
: BaseModel
{
[Required]
public virtual string Name { get; set; }
[Required]
public virtual string Description { get; set; }
[Required]
public virtual string Body { get; set; }
[Required]
public virtual int Type { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual int Id { get; set; }
}
public partial class NewsletterTemplate
: BaseModel
{
public virtual SendMethod SendMethod { get; set; }
public virtual EmailTemplate EmailTemplate { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string Heading { get; set; }
[Required]
public virtual string Body { get; set; }
public virtual string ImageUrl { get; set; }
[Required]
public virtual int SendMethodId { get; set; }
public virtual int? EmailTemplateId { get; set; }
[Required]
public virtual DateTime Created { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
public partial class SendMethod
: BaseModel
{
[Required]
public virtual string Name { get; set; }
[Required]
public virtual string Description { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual int Id { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class NewsletterEmailTemplatesQueryResponse
{
///<summary>
///The email template id
///</summary>
[ApiMember(Description="The email template id")]
public virtual int Id { get; set; }
///<summary>
///The email template name.
///</summary>
[ApiMember(Description="The email template name.")]
public virtual string Name { get; set; }
///<summary>
///The email template description.
///</summary>
[ApiMember(Description="The email template description.")]
public virtual string Description { get; set; }
///<summary>
///The email template html content.
///</summary>
[ApiMember(Description="The email template html content.")]
public virtual string Body { get; set; }
}
public partial class NewsletterSendMethodQueryResponse
{
///<summary>
///The send method id
///</summary>
[ApiMember(Description="The send method id")]
public virtual int Id { get; set; }
///<summary>
///The send method name.
///</summary>
[ApiMember(Description="The send method name.")]
public virtual string Name { get; set; }
///<summary>
///The send method description.
///</summary>
[ApiMember(Description="The send method description.")]
public virtual string Description { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class NewsletterTemplatesQuery
: QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse>, ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///The newsletter template id.
///</summary>
[ApiMember(Description="The newsletter template id.")]
public virtual int? Id { get; set; }
///<summary>
///If you want to include the message send method information
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include the message send method information", ParameterType="query")]
public virtual bool IncludeSendMethodInformation { get; set; }
///<summary>
///If you want to include the email template information
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")]
public virtual bool IncludeEmailTemplateInformation { get; set; }
}
public partial class NewsletterTemplatesQueryResponse
{
///<summary>
///The newsletter template id
///</summary>
[ApiMember(Description="The newsletter template id")]
public virtual int Id { get; set; }
///<summary>
///The newsletter template heading.
///</summary>
[ApiMember(Description="The newsletter template heading.")]
public virtual string Heading { get; set; }
///<summary>
///The newsletter template body.
///</summary>
[ApiMember(Description="The newsletter template body.")]
public virtual string Body { get; set; }
///<summary>
///The email template the newsletter uses.
///</summary>
[ApiMember(Description="The email template the newsletter uses.")]
public virtual int? EmailTemplateId { get; set; }
///<summary>
///Send Method. 1 = Email, 2 = SMS
///</summary>
[ApiMember(Description="Send Method. 1 = Email, 2 = SMS")]
public virtual int SendMethodId { get; set; }
///<summary>
///The newsletter template image url.
///</summary>
[ApiMember(Description="The newsletter template image url.")]
public virtual string ImageUrl { get; set; }
///<summary>
///The newsletter created date.
///</summary>
[ApiMember(Description="The newsletter created date.")]
public virtual DateTime Created { get; set; }
///<summary>
///Send method information.
///</summary>
[ApiMember(Description="Send method information.")]
public virtual NewsletterSendMethodQueryResponse SendMethodInformation { get; set; }
///<summary>
///Email template information.
///</summary>
[ApiMember(Description="Email template information.")]
public virtual NewsletterEmailTemplatesQueryResponse EmailTemplateInformation { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<summary>
///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>
///</summary>
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=2)]
public virtual int? Take { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
///<summary>
///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>
///</summary>
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# NewsletterTemplatesQuery 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.
GET /newsletter/templates HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}