| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates | Create a new company newsletter template. | Create a new company newsletter template. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class CreateNewsletterTemplate
: 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 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 newsletter template image url.
///</summary>
[ApiMember(Description="The newsletter template image url.")]
public virtual string ImageUrl { get; set; }
///<summary>
///The newsletter template send method (1=email, 2=sms).
///</summary>
[ApiMember(Description="The newsletter template send method (1=email, 2=sms).")]
public virtual int SendMethodId { get; set; }
///<summary>
///The email template id. Get valid email templates from GET /newsletter/emailtemplates
///</summary>
[ApiMember(Description="The email template id. Get valid email templates from GET /newsletter/emailtemplates")]
public virtual int? EmailTemplateId { 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; }
}
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; }
}
}
C# CreateNewsletterTemplate 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.
POST /newsletter/templates HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
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
}
}