| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| POST | /messages/sendsms | Send email to any mobile phone recipient | Send SMS to any mobile phone recipient. |
|---|
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 SendSMS 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 message receiver phone number (valid mobile number).
*/
// @ApiMember(Description="The message receiver phone number (valid mobile number).")
String? Receiver;
/**
* Message Body.
*/
// @ApiMember(Description="Message Body.")
String? MessageBody;
/**
* When the message will be sent.
*/
// @ApiMember(Description="When the message will be sent.")
DateTime? ToSendDate;
SendSMS({this.CompanyId,this.Receiver,this.MessageBody,this.ToSendDate});
SendSMS.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Receiver = json['Receiver'];
MessageBody = json['MessageBody'];
ToSendDate = JsonConverters.fromJson(json['ToSendDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Receiver': Receiver,
'MessageBody': MessageBody,
'ToSendDate': JsonConverters.toJson(ToSendDate,'DateTime',context!)
};
getTypeName() => "SendSMS";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'MessageLogQueryResponse': TypeInfo(TypeOf.Class, create:() => MessageLogQueryResponse()),
'SendSMS': TypeInfo(TypeOf.Class, create:() => SendSMS()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /messages/sendsms HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SendSMS 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>
<MessageBody>String</MessageBody>
<Receiver>String</Receiver>
<ToSendDate>0001-01-01T00:00:00</ToSendDate>
</SendSMS>
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>