BokaMera.API.Host

<back to all web services

SendEmailToCompany

The following routes are available for this service:
POST/messages/sendemailtocompanySend email to company with id or sitepathThis is used by the homepage to send emails to the company
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class SendEmailToCompany : ICompany
{
    /**
    * The company id, if empty you will need to provide the sitepath instead.
    */
    @ApiMember(Description="The company id, if empty you will need to provide the sitepath instead.")
    var CompanyId:UUID? = null

    /**
    * Message Title.
    */
    @ApiMember(Description="Message Title.")
    var MessageTitle:String? = null

    /**
    * Message Body.
    */
    @ApiMember(Description="Message Body.")
    var MessageBody:String? = null

    /**
    * Message Sender Name.
    */
    @ApiMember(Description="Message Sender Name.")
    var Name:String? = null

    /**
    * Message Sender Email.
    */
    @ApiMember(Description="Message Sender Email.")
    var Email:String? = null

    /**
    * Message Sender Phone Number.
    */
    @ApiMember(Description="Message Sender Phone Number.")
    var Phone:String? = null

    /**
    * The homeage sitepath.
    */
    @ApiMember(Description="The homeage sitepath.")
    var SitePath:String? = null
}

open class MessageLogQueryResponse
{
    /**
    * The message log id
    */
    @ApiMember(Description="The message log id")
    var Id:Int? = null

    /**
    * The booking id for the message (if connected to a booking).
    */
    @ApiMember(Description="The booking id for the message (if connected to a booking).")
    var BookingId:Int? = null

    /**
    * The message receiver. Either a email or a mobile phone number.
    */
    @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
    var Receiver:String? = null

    /**
    * Message Title.
    */
    @ApiMember(Description="Message Title.")
    var MessageTitle:String? = null

    /**
    * Message Storage Url.
    */
    @ApiMember(Description="Message Storage Url.")
    var StorageUrl:String? = null

    /**
    * Message Body.
    */
    @ApiMember(Description="Message Body.")
    var MessageBody:String? = null

    /**
    * When message was created.
    */
    @ApiMember(Description="When message was created.")
    var Created:Date? = null

    /**
    * When the message will be sent.
    */
    @ApiMember(Description="When the message will be sent.")
    var ToSendDate:Date? = null

    /**
    * When the message was sent.
    */
    @ApiMember(Description="When the message was sent.")
    var SentDate:Date? = null

    /**
    * If Message is sent
    */
    @ApiMember(Description="If Message is sent")
    var Sent:Boolean? = null

    /**
    * Number of retries to send the message
    */
    @ApiMember(Description="Number of retries to send the message")
    var MessageRetries:Int? = null

    /**
    * Send Method. 1 = Email, 2 = SMS
    */
    @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    var SendMethodId:Int? = null
}

Kotlin SendEmailToCompany 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/sendemailtocompany HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendEmailToCompany 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>
  <Email>String</Email>
  <MessageBody>String</MessageBody>
  <MessageTitle>String</MessageTitle>
  <Name>String</Name>
  <Phone>String</Phone>
  <SitePath>String</SitePath>
</SendEmailToCompany>
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>