| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /bookinglog | Find booking log for booking. |
|---|
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 BookingLogEventTypeResponse implements IConvertible
{
/**
* The event type id
*/
// @ApiMember(Description="The event type id")
int? Id;
/**
* The event type name
*/
// @ApiMember(Description="The event type name")
String? Name;
/**
* The event type description
*/
// @ApiMember(Description="The event type description")
String? Description;
BookingLogEventTypeResponse({this.Id,this.Name,this.Description});
BookingLogEventTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Description': Description
};
getTypeName() => "BookingLogEventTypeResponse";
TypeContext? context = _ctx;
}
class BookingLogQueryResponse implements IConvertible
{
/**
* The booking log id
*/
// @ApiMember(Description="The booking log id")
int? Id;
/**
* The booking id
*/
// @ApiMember(Description="The booking id")
int? BookingId;
/**
* The type of event
*/
// @ApiMember(Description="The type of event")
int? EventTypeId;
/**
* The type of event
*/
// @ApiMember(Description="The type of event")
BookingLogEventTypeResponse? EventType;
/**
* Comments that could be added to the event log item
*/
// @ApiMember(Description="Comments that could be added to the event log item")
String? Comments;
/**
* The user created the event
*/
// @ApiMember(Description="The user created the event")
String? UserName;
/**
* Then date when the event occured
*/
// @ApiMember(Description="Then date when the event occured")
DateTime? Created;
BookingLogQueryResponse({this.Id,this.BookingId,this.EventTypeId,this.EventType,this.Comments,this.UserName,this.Created});
BookingLogQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
BookingId = json['BookingId'];
EventTypeId = json['EventTypeId'];
EventType = JsonConverters.fromJson(json['EventType'],'BookingLogEventTypeResponse',context!);
Comments = json['Comments'];
UserName = json['UserName'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'BookingId': BookingId,
'EventTypeId': EventTypeId,
'EventType': JsonConverters.toJson(EventType,'BookingLogEventTypeResponse',context!),
'Comments': Comments,
'UserName': UserName,
'Created': JsonConverters.toJson(Created,'DateTime',context!)
};
getTypeName() => "BookingLogQueryResponse";
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 BookingLogEventType extends BaseModel implements IConvertible
{
// @Required()
String? Name;
// @Required()
String? Description;
DateTime? ModifiedDate;
// @Required()
int? Id;
BookingLogEventType({this.Name,this.Description,this.ModifiedDate,this.Id});
BookingLogEventType.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Name = json['Name'];
Description = json['Description'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Name': Name,
'Description': Description,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "BookingLogEventType";
TypeContext? context = _ctx;
}
class BookingLog extends BaseModel implements IConvertible
{
// @References(typeof(BookingLogEventType))
int? EventTypeId;
BookingLogEventType? EventType;
// @Required()
String? CompanyId;
// @Required()
int? BookingId;
int? Id;
String? Comments;
String? UserId;
// @Required()
DateTime? Created;
DateTime? ModifiedDate;
BookingLog({this.EventTypeId,this.EventType,this.CompanyId,this.BookingId,this.Id,this.Comments,this.UserId,this.Created,this.ModifiedDate});
BookingLog.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
EventTypeId = json['EventTypeId'];
EventType = JsonConverters.fromJson(json['EventType'],'BookingLogEventType',context!);
CompanyId = json['CompanyId'];
BookingId = json['BookingId'];
Id = json['Id'];
Comments = json['Comments'];
UserId = json['UserId'];
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'EventTypeId': EventTypeId,
'EventType': JsonConverters.toJson(EventType,'BookingLogEventType',context!),
'CompanyId': CompanyId,
'BookingId': BookingId,
'Id': Id,
'Comments': Comments,
'UserId': UserId,
'Created': JsonConverters.toJson(Created,'DateTime',context!),
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "BookingLog";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
class BookingLogQuery extends QueryDb2<BookingLog,BookingLogQueryResponse> implements IConvertible
{
/**
* Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used
*/
// @ApiMember(Description="Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used", IsRequired=true, ParameterType="query")
String? CompanyId;
/**
* Enter the booking id you want to get the log
*/
// @ApiMember(Description="Enter the booking id you want to get the log", IsRequired=true, ParameterType="query")
int? BookingId;
BookingLogQuery({this.CompanyId,this.BookingId});
BookingLogQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
BookingId = json['BookingId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'BookingId': BookingId
});
getTypeName() => "BookingLogQuery";
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> {
'BookingLogEventTypeResponse': TypeInfo(TypeOf.Class, create:() => BookingLogEventTypeResponse()),
'BookingLogQueryResponse': TypeInfo(TypeOf.Class, create:() => BookingLogQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'BookingLogEventType': TypeInfo(TypeOf.Class, create:() => BookingLogEventType()),
'BookingLog': TypeInfo(TypeOf.Class, create:() => BookingLog()),
'BookingLogQuery': TypeInfo(TypeOf.Class, create:() => BookingLogQuery()),
'List<BookingLogQueryResponse>': TypeInfo(TypeOf.Class, create:() => <BookingLogQueryResponse>[]),
'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 /bookinglog 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,
EventTypeId: 0,
EventType:
{
Id: 0,
Name: String,
Description: String
},
Comments: String,
UserName: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}