| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /messages/log | Search the message log for any messages | Search the message log for any messages. |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
abstract class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
// @DataMember(Order=1)
int? Skip;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
// @DataMember(Order=2)
int? Take;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
// @DataMember(Order=3)
String? OrderBy;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
// @DataMember(Order=4)
String? OrderByDesc;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
// @DataMember(Order=5)
String? Include;
// @DataMember(Order=6)
String? Fields;
// @DataMember(Order=7)
Map<String,String?>? Meta;
QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Skip = json['Skip'];
Take = json['Take'];
OrderBy = json['OrderBy'];
OrderByDesc = json['OrderByDesc'];
Include = json['Include'];
Fields = json['Fields'];
Meta = JsonConverters.toStringMap(json['Meta']);
return this;
}
Map<String, dynamic> toJson() => {
'Skip': Skip,
'Take': Take,
'OrderBy': OrderBy,
'OrderByDesc': OrderByDesc,
'Include': Include,
'Fields': Fields,
'Meta': Meta
};
getTypeName() => "QueryBase";
TypeContext? context = _ctx;
}
abstract class QueryDb2<From,Into> extends QueryBase
{
QueryDb2();
QueryDb2.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "QueryDb<$From,$Into>";
TypeContext? context = _ctx;
}
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;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
class MessageLog extends BaseModel implements IMessageLog, IConvertible
{
int? BookingId;
// @Required()
bool? PublicMessage;
// @Required()
int? MessageType;
// @Required()
bool? iCalAttachment;
// @Required()
String? SenderName;
DateTime? ModifiedDate;
String? CorrelationId;
// @Required()
String? CompanyId;
int? Id;
// @Required()
String? Receiver;
// @Required()
String? Sender;
String? MessageTitle;
// @Required()
String? MessageBody;
String? CreatedBy;
// @Required()
DateTime? Created;
// @Required()
bool? Sent;
// @Required()
DateTime? ToSendDate;
DateTime? SentDate;
// @Required()
int? SendMethodId;
int? MessageCount;
int? SMSStatus;
// @Required()
int? MessageRetries;
String? StorageUrl;
String? Language;
MessageLog({this.BookingId,this.PublicMessage,this.MessageType,this.iCalAttachment,this.SenderName,this.ModifiedDate,this.CorrelationId,this.CompanyId,this.Id,this.Receiver,this.Sender,this.MessageTitle,this.MessageBody,this.CreatedBy,this.Created,this.Sent,this.ToSendDate,this.SentDate,this.SendMethodId,this.MessageCount,this.SMSStatus,this.MessageRetries,this.StorageUrl,this.Language});
MessageLog.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
BookingId = json['BookingId'];
PublicMessage = json['PublicMessage'];
MessageType = json['MessageType'];
iCalAttachment = json['iCalAttachment'];
SenderName = json['SenderName'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
CorrelationId = json['CorrelationId'];
CompanyId = json['CompanyId'];
Id = json['Id'];
Receiver = json['Receiver'];
Sender = json['Sender'];
MessageTitle = json['MessageTitle'];
MessageBody = json['MessageBody'];
CreatedBy = json['CreatedBy'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
Sent = json['Sent'];
ToSendDate = JsonConverters.fromJson(json['ToSendDate'],'DateTime',context!);
SentDate = JsonConverters.fromJson(json['SentDate'],'DateTime',context!);
SendMethodId = json['SendMethodId'];
MessageCount = json['MessageCount'];
SMSStatus = json['SMSStatus'];
MessageRetries = json['MessageRetries'];
StorageUrl = json['StorageUrl'];
Language = json['Language'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'BookingId': BookingId,
'PublicMessage': PublicMessage,
'MessageType': MessageType,
'iCalAttachment': iCalAttachment,
'SenderName': SenderName,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'CorrelationId': CorrelationId,
'CompanyId': CompanyId,
'Id': Id,
'Receiver': Receiver,
'Sender': Sender,
'MessageTitle': MessageTitle,
'MessageBody': MessageBody,
'CreatedBy': CreatedBy,
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'Sent': Sent,
'ToSendDate': JsonConverters.toJson(ToSendDate,'DateTime',context!),
'SentDate': JsonConverters.toJson(SentDate,'DateTime',context!),
'SendMethodId': SendMethodId,
'MessageCount': MessageCount,
'SMSStatus': SMSStatus,
'MessageRetries': MessageRetries,
'StorageUrl': StorageUrl,
'Language': Language
});
getTypeName() => "MessageLog";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class MessageLogQuery extends QueryDb2<MessageLog,MessageLogQueryResponse> 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.", ParameterType="path")
String? CompanyId;
/**
* If you want to search on sent messages
*/
// @ApiMember(DataType="boolean", Description="If you want to search on sent messages", ParameterType="query")
bool? Sent;
/**
* Message Id
*/
// @ApiMember(DataType="int", Description="Message Id", ParameterType="query")
int? Id;
/**
* If you want to search on a messages for a specific booking
*/
// @ApiMember(DataType="int", Description="If you want to search on a messages for a specific booking", ParameterType="query")
int? BookingId;
/**
* If you want to search on a messages for a specific receiver
*/
// @ApiMember(DataType="string", Description="If you want to search on a messages for a specific receiver", ParameterType="query")
String? Receiver;
/**
* If you want to search on a messages created a specific date
*/
// @ApiMember(DataType="datetime", Description="If you want to search on a messages created a specific date", ParameterType="query")
DateTime? Created;
/**
* If you want to search on a messages sent a specific date
*/
// @ApiMember(DataType="datetime", Description="If you want to search on a messages sent a specific date", ParameterType="query")
DateTime? SentDate;
ResponseStatus? ResponseStatus;
MessageLogQuery({this.CompanyId,this.Sent,this.Id,this.BookingId,this.Receiver,this.Created,this.SentDate,this.ResponseStatus});
MessageLogQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
Sent = json['Sent'];
Id = json['Id'];
BookingId = json['BookingId'];
Receiver = json['Receiver'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
SentDate = JsonConverters.fromJson(json['SentDate'],'DateTime',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'Sent': Sent,
'Id': Id,
'BookingId': BookingId,
'Receiver': Receiver,
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'SentDate': JsonConverters.toJson(SentDate,'DateTime',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
});
getTypeName() => "MessageLogQuery";
TypeContext? context = _ctx;
}
class AccessKeyTypeResponse implements IConvertible
{
int? Id;
String? KeyType;
String? Description;
AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
KeyType = json['KeyType'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'KeyType': KeyType,
'Description': Description
};
getTypeName() => "AccessKeyTypeResponse";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
// @DataMember(Order=1)
int? Offset;
// @DataMember(Order=2)
int? Total;
// @DataMember(Order=3)
List<AccessKeyTypeResponse>? Results;
// @DataMember(Order=4)
Map<String,String?>? Meta;
// @DataMember(Order=5)
ResponseStatus? ResponseStatus;
QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Total = json['Total'];
Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
Meta = JsonConverters.toStringMap(json['Meta']);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Total': Total,
'Results': JsonConverters.toJson(Results,'List<AccessKeyTypeResponse>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'MessageLogQueryResponse': TypeInfo(TypeOf.Class, create:() => MessageLogQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'MessageLog': TypeInfo(TypeOf.Class, create:() => MessageLog()),
'MessageLogQuery': TypeInfo(TypeOf.Class, create:() => MessageLogQuery()),
'List<MessageLogQueryResponse>': TypeInfo(TypeOf.Class, create:() => <MessageLogQueryResponse>[]),
'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});
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.
GET /messages/log HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
BookingId: 0,
Receiver: String,
MessageTitle: String,
StorageUrl: String,
MessageBody: String,
SentDate: "0001-01-01T00:00:00",
Sent: False,
MessageRetries: 0,
SendMethodId: 0
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}