BokaMera.API.Host

TestSendMessageTemplate

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

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

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class TestSendMessageTemplate : ICompany, Codable
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public var companyId:String?

    /**
    * 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.
    */
    // @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 var receiver:String

    /**
    * The message template title.
    */
    // @ApiMember(Description="The message template title.")
    public var title:String

    /**
    * The newsletter template body.
    */
    // @ApiMember(Description="The newsletter template body.", IsRequired=true)
    public var body:String

    /**
    * The message type id. See GET /messages/templates/types 
    */
    // @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
    public var typeId:Int?

    /**
    * Message template lanugage
    */
    // @ApiMember(Description="Message template lanugage", IsRequired=true)
    public var language:String

    /**
    * The services that is connected to the message. If null it will be connected to all services.
    */
    // @ApiMember(Description="The services that is connected to the message. If null it will be connected to all services.")
    public var services:[Int] = []

    required public init(){}
}

public class MessageLogQueryResponse : Codable
{
    /**
    * The message log id
    */
    // @ApiMember(Description="The message log id")
    public var id:Int

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

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

    /**
    * Message Title.
    */
    // @ApiMember(Description="Message Title.")
    public var messageTitle:String

    /**
    * Message Storage Url.
    */
    // @ApiMember(Description="Message Storage Url.")
    public var storageUrl:String

    /**
    * Message Body.
    */
    // @ApiMember(Description="Message Body.")
    public var messageBody:String

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

    /**
    * When the message will be sent.
    */
    // @ApiMember(Description="When the message will be sent.")
    public var toSendDate:Date

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

    /**
    * If Message is sent
    */
    // @ApiMember(Description="If Message is sent")
    public var sent:Bool

    /**
    * Number of retries to send the message
    */
    // @ApiMember(Description="Number of retries to send the message")
    public var messageRetries:Int

    /**
    * Send Method. 1 = Email, 2 = SMS
    */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public var sendMethodId:Int

    required public init(){}
}

Swift TestSendMessageTemplate 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/templates/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestSendMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Language>String</Language>
  <Receiver>String</Receiver>
  <Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Services>
  <Title>String</Title>
  <TypeId>0</TypeId>
</TestSendMessageTemplate>

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>