| 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 java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class TestSendMessageTemplate : ICompany
{
/**
* 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.")
var CompanyId:UUID? = null
/**
* 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)
var Receiver:String? = null
/**
* The message template title.
*/
@ApiMember(Description="The message template title.")
var Title:String? = null
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.", IsRequired=true)
var Body:String? = null
/**
* The message type id. See GET /messages/templates/types
*/
@ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
var TypeId:Int? = null
/**
* Message template lanugage
*/
@ApiMember(Description="Message template lanugage", IsRequired=true)
var Language:String? = null
/**
* 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.")
var Services:ArrayList<Int>? = 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 TestSendMessageTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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}