BokaMera.API.Host

<back to all web services

SendEmail

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
POST/messages/sendemailSend email to any email recipientSend email to any email recipient.
"use strict";
export class MessageLogQueryResponse {
    /** @param {{Id?:number,BookingId?:number,Receiver?:string,MessageTitle?:string,StorageUrl?: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 {?number}
     * @description The booking id for the message (if connected to a booking). */
    BookingId;
    /**
     * @type {string}
     * @description The message receiver. Either a email or a mobile phone number. */
    Receiver;
    /**
     * @type {string}
     * @description Message Title. */
    MessageTitle;
    /**
     * @type {string}
     * @description Message Storage Url. */
    StorageUrl;
    /**
     * @type {string}
     * @description Message 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 SendEmail {
    /** @param {{CompanyId?:string,Receiver?:string,MessageTitle?:string,MessageBody?:string,ToSendDate?:string}} [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 message receiver email. */
    Receiver;
    /**
     * @type {string}
     * @description Message Title. */
    MessageTitle;
    /**
     * @type {string}
     * @description Message Body. */
    MessageBody;
    /**
     * @type {string}
     * @description When the message will be sent. */
    ToSendDate;
}

JavaScript SendEmail 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 /messages/sendemail HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendEmail 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>
  <MessageBody>String</MessageBody>
  <MessageTitle>String</MessageTitle>
  <Receiver>String</Receiver>
  <ToSendDate>0001-01-01T00:00:00</ToSendDate>
</SendEmail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageLogQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <Created>0001-01-01T00:00:00</Created>
  <Id>0</Id>
  <MessageBody>String</MessageBody>
  <MessageRetries>0</MessageRetries>
  <MessageTitle>String</MessageTitle>
  <Receiver>String</Receiver>
  <SendMethodId>0</SendMethodId>
  <Sent>false</Sent>
  <SentDate>0001-01-01T00:00:00</SentDate>
  <StorageUrl>String</StorageUrl>
  <ToSendDate>0001-01-01T00:00:00</ToSendDate>
</MessageLogQueryResponse>