BokaMera.API.Host

<back to all web services

TestSendNewsLetter

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/newsletter/templates/testTest to send a newsletter to a Email or Mobile phone recepient using SMS.
"use strict";
export class NewsletterLogQueryResponse {
    /** @param {{Id?:number,Receiver?:string,MessageTitle?:string,MessageBody?:string,Created?:string,ToSendDate?:string,SentDate?:string,Sent?:boolean,MessageRetries?:number,SendMethodId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The message log id */
    Id;
    /**
     * @type {string}
     * @description The message receiver. Either a email or a mobile phone number. */
    Receiver;
    /**
     * @type {string}
     * @description Nessage Title. */
    MessageTitle;
    /**
     * @type {string}
     * @description Nessage Body. */
    MessageBody;
    /**
     * @type {string}
     * @description When message was created. */
    Created;
    /**
     * @type {string}
     * @description When the message will be sent. */
    ToSendDate;
    /**
     * @type {?string}
     * @description When the message was sent. */
    SentDate;
    /**
     * @type {boolean}
     * @description If Message is sent */
    Sent;
    /**
     * @type {number}
     * @description Number of retries to send the message */
    MessageRetries;
    /**
     * @type {number}
     * @description Send Method. 1 = Email, 2 = SMS */
    SendMethodId;
}
export class TestSendNewsLetter {
    /** @param {{CompanyId?:string,Receiver?:string,Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @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. */
    Receiver;
    /**
     * @type {number}
     * @description The newsletter template id. */
    Id;
}

JavaScript 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: api.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
}