| 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 'package:servicestack/servicestack.dart';
class MessageLogQueryResponse implements IConvertible
{
/**
* The message log id
*/
// @ApiMember(Description="The message log id")
int? Id;
/**
* The booking id for the message (if connected to a booking).
*/
// @ApiMember(Description="The booking id for the message (if connected to a booking).")
int? BookingId;
/**
* The message receiver. Either a email or a mobile phone number.
*/
// @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
String? Receiver;
/**
* Message Title.
*/
// @ApiMember(Description="Message Title.")
String? MessageTitle;
/**
* Message Storage Url.
*/
// @ApiMember(Description="Message Storage Url.")
String? StorageUrl;
/**
* Message Body.
*/
// @ApiMember(Description="Message Body.")
String? MessageBody;
/**
* When message was created.
*/
// @ApiMember(Description="When message was created.")
DateTime? Created;
/**
* When the message will be sent.
*/
// @ApiMember(Description="When the message will be sent.")
DateTime? ToSendDate;
/**
* When the message was sent.
*/
// @ApiMember(Description="When the message was sent.")
DateTime? SentDate;
/**
* If Message is sent
*/
// @ApiMember(Description="If Message is sent")
bool? Sent;
/**
* Number of retries to send the message
*/
// @ApiMember(Description="Number of retries to send the message")
int? MessageRetries;
/**
* Send Method. 1 = Email, 2 = SMS
*/
// @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
int? SendMethodId;
MessageLogQueryResponse({this.Id,this.BookingId,this.Receiver,this.MessageTitle,this.StorageUrl,this.MessageBody,this.Created,this.ToSendDate,this.SentDate,this.Sent,this.MessageRetries,this.SendMethodId});
MessageLogQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
BookingId = json['BookingId'];
Receiver = json['Receiver'];
MessageTitle = json['MessageTitle'];
StorageUrl = json['StorageUrl'];
MessageBody = json['MessageBody'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
ToSendDate = JsonConverters.fromJson(json['ToSendDate'],'DateTime',context!);
SentDate = JsonConverters.fromJson(json['SentDate'],'DateTime',context!);
Sent = json['Sent'];
MessageRetries = json['MessageRetries'];
SendMethodId = json['SendMethodId'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'BookingId': BookingId,
'Receiver': Receiver,
'MessageTitle': MessageTitle,
'StorageUrl': StorageUrl,
'MessageBody': MessageBody,
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'ToSendDate': JsonConverters.toJson(ToSendDate,'DateTime',context!),
'SentDate': JsonConverters.toJson(SentDate,'DateTime',context!),
'Sent': Sent,
'MessageRetries': MessageRetries,
'SendMethodId': SendMethodId
};
getTypeName() => "MessageLogQueryResponse";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class TestSendMessageTemplate implements ICompany, IConvertible
{
/**
* 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.")
String? CompanyId;
/**
* 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)
String? Receiver;
/**
* The message template title.
*/
// @ApiMember(Description="The message template title.")
String? Title;
/**
* The newsletter template body.
*/
// @ApiMember(Description="The newsletter template body.", IsRequired=true)
String? Body;
/**
* The message type id. See GET /messages/templates/types
*/
// @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
int? TypeId;
/**
* Message template lanugage
*/
// @ApiMember(Description="Message template lanugage", IsRequired=true)
String? Language;
/**
* 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.")
List<int>? Services;
TestSendMessageTemplate({this.CompanyId,this.Receiver,this.Title,this.Body,this.TypeId,this.Language,this.Services});
TestSendMessageTemplate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Receiver = json['Receiver'];
Title = json['Title'];
Body = json['Body'];
TypeId = json['TypeId'];
Language = json['Language'];
Services = JsonConverters.fromJson(json['Services'],'List<int>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Receiver': Receiver,
'Title': Title,
'Body': Body,
'TypeId': TypeId,
'Language': Language,
'Services': JsonConverters.toJson(Services,'List<int>',context!)
};
getTypeName() => "TestSendMessageTemplate";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'MessageLogQueryResponse': TypeInfo(TypeOf.Class, create:() => MessageLogQueryResponse()),
'TestSendMessageTemplate': TypeInfo(TypeOf.Class, create:() => TestSendMessageTemplate()),
});
Dart 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
}