BokaMera.API.Host

CreateNewsletterTemplate

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/newsletter/templates	Create a new company newsletter template.	Create a new company newsletter template.


export class NewsletterSendMethodQueryResponse
{
    /** @description The send method id */
    // @ApiMember(Description="The send method id")
    public Id: number;

    /** @description The send method name. */
    // @ApiMember(Description="The send method name.")
    public Name: string;

    /** @description The send method description. */
    // @ApiMember(Description="The send method description.")
    public Description: string;

    public constructor(init?: Partial<NewsletterSendMethodQueryResponse>) { (Object as any).assign(this, init); }
}

export class NewsletterEmailTemplatesQueryResponse
{
    /** @description The email template id */
    // @ApiMember(Description="The email template id")
    public Id: number;

    /** @description The email template name. */
    // @ApiMember(Description="The email template name.")
    public Name: string;

    /** @description The email template description. */
    // @ApiMember(Description="The email template description.")
    public Description: string;

    /** @description The email template html content. */
    // @ApiMember(Description="The email template html content.")
    public Body: string;

    public constructor(init?: Partial<NewsletterEmailTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}

export class NewsletterTemplatesQueryResponse
{
    /** @description The newsletter template id */
    // @ApiMember(Description="The newsletter template id")
    public Id: number;

    /** @description The newsletter template heading. */
    // @ApiMember(Description="The newsletter template heading.")
    public Heading: string;

    /** @description The newsletter template body. */
    // @ApiMember(Description="The newsletter template body.")
    public Body: string;

    /** @description The email template the newsletter uses. */
    // @ApiMember(Description="The email template the newsletter uses.")
    public EmailTemplateId?: number;

    /** @description Send Method. 1 = Email, 2 = SMS */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public SendMethodId: number;

    /** @description The newsletter template image url. */
    // @ApiMember(Description="The newsletter template image url.")
    public ImageUrl: string;

    /** @description The newsletter created date. */
    // @ApiMember(Description="The newsletter created date.")
    public Created: string;

    /** @description Send method information. */
    // @ApiMember(Description="Send method information.")
    public SendMethodInformation: NewsletterSendMethodQueryResponse;

    /** @description Email template information. */
    // @ApiMember(Description="Email template information.")
    public EmailTemplateInformation: NewsletterEmailTemplatesQueryResponse;

    public constructor(init?: Partial<NewsletterTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateNewsletterTemplate implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description The newsletter template heading. */
    // @ApiMember(Description="The newsletter template heading.")
    public Heading: string;

    /** @description The newsletter template body. */
    // @ApiMember(Description="The newsletter template body.")
    public Body: string;

    /** @description The newsletter template image url. */
    // @ApiMember(Description="The newsletter template image url.")
    public ImageUrl: string;

    /** @description The newsletter template send method (1=email, 2=sms). */
    // @ApiMember(Description="The newsletter template send method (1=email, 2=sms).")
    public SendMethodId: number;

    /** @description 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 EmailTemplateId?: number;

    public constructor(init?: Partial<CreateNewsletterTemplate>) { (Object as any).assign(this, init); }
}

TypeScript CreateNewsletterTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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/csv
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"}}