BokaMera.API.Host

SendNewsLetter

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

The following routes are available for this service:
POST	/newsletter/send	Send a newsletter to a customers.

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 SendNewsLetter
        : ICompany
    {
        public SendNewsLetter()
        {
            Customers = new List<Guid>{};
        }

        ///<summary>
        ///The newsletter template id.
        ///</summary>
        [ApiMember(Description="The newsletter template id.", IsRequired=true)]
        public virtual int Id { get; set; }

        ///<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 datetime when the newsletters should be sent.
        ///</summary>
        [ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)]
        public virtual DateTime SendDate { get; set; }

        ///<summary>
        ///The customer ids to send newsletters to.
        ///</summary>
        [ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)]
        public virtual List<Guid> Customers { get; set; }
    }

    public partial class SendNewslettersResponse
    {
        ///<summary>
        ///The number of messages that are added into queue.
        ///</summary>
        [ApiMember(Description="The number of messages that are added into queue.")]
        public virtual int Total { 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>
        ///Message example sent (in HTML format)
        ///</summary>
        [ApiMember(Description="Message example sent (in HTML format)")]
        public virtual string MessageExample { get; set; }
    }

}

C# SendNewsLetter DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /newsletter/send HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendNewsLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Customers>
  <Id>0</Id>
  <SendDate>0001-01-01T00:00:00</SendDate>
</SendNewsLetter>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendNewslettersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <MessageExample>String</MessageExample>
  <SendMethodId>0</SendMethodId>
  <Total>0</Total>
</SendNewslettersResponse>