BokaMera.API.Host

TestSendNewsLetter

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

The following routes are available for this service:
POST	/newsletter/templates/test	Test to send a newsletter to a Email or Mobile phone recepient using SMS.

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
{
    public partial class NewsletterLogQueryResponse
    {
        ///<summary>
        ///The message log id
        ///</summary>
        [ApiMember(Description="The message log id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The message receiver. Either a email or a mobile phone number.
        ///</summary>
        [ApiMember(Description="The message receiver. Either a email or a mobile phone number.")]
        public virtual string Receiver { get; set; }

        ///<summary>
        ///Nessage Title.
        ///</summary>
        [ApiMember(Description="Nessage Title.")]
        public virtual string MessageTitle { get; set; }

        ///<summary>
        ///Nessage Body.
        ///</summary>
        [ApiMember(Description="Nessage Body.")]
        public virtual string MessageBody { get; set; }

        ///<summary>
        ///When message was created.
        ///</summary>
        [ApiMember(Description="When message was created.")]
        public virtual DateTime Created { get; set; }

        ///<summary>
        ///When the message will be sent.
        ///</summary>
        [ApiMember(Description="When the message will be sent.")]
        public virtual DateTime ToSendDate { get; set; }

        ///<summary>
        ///When the message was sent.
        ///</summary>
        [ApiMember(Description="When the message was sent.")]
        public virtual DateTime? SentDate { get; set; }

        ///<summary>
        ///If Message is sent
        ///</summary>
        [ApiMember(Description="If Message is sent")]
        public virtual bool Sent { get; set; }

        ///<summary>
        ///Number of retries to send the message
        ///</summary>
        [ApiMember(Description="Number of retries to send the message")]
        public virtual int MessageRetries { get; set; }

        ///<summary>
        ///Send Method. 1 = Email, 2 = SMS
        ///</summary>
        [ApiMember(Description="Send Method. 1 = Email, 2 = SMS")]
        public virtual int SendMethodId { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class TestSendNewsLetter
        : 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 email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.
        ///</summary>
        [ApiMember(Description="The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.", IsRequired=true)]
        public virtual string Receiver { get; set; }

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

}

C# TestSendNewsLetter DTOs

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

HTTP + JSV

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

POST /newsletter/templates/test HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Receiver: String,
	Id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Receiver: String,
	MessageTitle: String,
	MessageBody: String,
	SentDate: "0001-01-01T00:00:00",
	Sent: False,
	MessageRetries: 0,
	SendMethodId: 0
}