| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Receiver: String,
Title: String,
Body: String,
TypeId: 0,
Language: String,
Services:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
BookingId: 0,
Receiver: String,
MessageTitle: String,
StorageUrl: String,
MessageBody: String,
SentDate: "0001-01-01T00:00:00",
Sent: False,
MessageRetries: 0,
SendMethodId: 0
}