| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /bookings/reports/ | Get all reports | Get a list of all existing reports. |
|---|
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 BookingPrintoutQueryResponse implements IConvertible
{
/**
* Report id
*/
// @ApiMember(Description="Report id")
int? Id;
/**
* Report Name
*/
// @ApiMember(Description="Report Name")
String? Name;
/**
* Report header left cell content
*/
// @ApiMember(Description="Report header left cell content", IsRequired=true)
String? HeaderLeftCell;
/**
* Report header middle cell content
*/
// @ApiMember(Description="Report header middle cell content", IsRequired=true)
String? HeaderMiddleCell;
/**
* Report header right cell content
*/
// @ApiMember(Description="Report header right cell content", IsRequired=true)
String? HeaderRightCell;
/**
* Report body cell content
*/
// @ApiMember(Description="Report body cell content", IsRequired=true)
String? BodyCell;
/**
* Report footer left cell content
*/
// @ApiMember(Description="Report footer left cell content", IsRequired=true)
String? FooterLeftCell;
/**
* Report footer middle cell content
*/
// @ApiMember(Description="Report footer middle cell content", IsRequired=true)
String? FooterMiddleCell;
/**
* Report footer right cell content
*/
// @ApiMember(Description="Report footer right cell content", IsRequired=true)
String? FooterRightCell;
BookingPrintoutQueryResponse({this.Id,this.Name,this.HeaderLeftCell,this.HeaderMiddleCell,this.HeaderRightCell,this.BodyCell,this.FooterLeftCell,this.FooterMiddleCell,this.FooterRightCell});
BookingPrintoutQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
HeaderLeftCell = json['HeaderLeftCell'];
HeaderMiddleCell = json['HeaderMiddleCell'];
HeaderRightCell = json['HeaderRightCell'];
BodyCell = json['BodyCell'];
FooterLeftCell = json['FooterLeftCell'];
FooterMiddleCell = json['FooterMiddleCell'];
FooterRightCell = json['FooterRightCell'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'HeaderLeftCell': HeaderLeftCell,
'HeaderMiddleCell': HeaderMiddleCell,
'HeaderRightCell': HeaderRightCell,
'BodyCell': BodyCell,
'FooterLeftCell': FooterLeftCell,
'FooterMiddleCell': FooterMiddleCell,
'FooterRightCell': FooterRightCell
};
getTypeName() => "BookingPrintoutQueryResponse";
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 BookingPrintout extends BaseModel implements IConvertible
{
// @Required()
String? CompanyId;
int? Id;
// @Required()
String? Name;
String? HeaderLeftCell;
String? HeaderMiddleCell;
String? HeaderRightCell;
// @Required()
String? BodyCell;
String? FooterLeftCell;
String? FooterMiddleCell;
String? FooterRightCell;
DateTime? ModifiedDate;
BookingPrintout({this.CompanyId,this.Id,this.Name,this.HeaderLeftCell,this.HeaderMiddleCell,this.HeaderRightCell,this.BodyCell,this.FooterLeftCell,this.FooterMiddleCell,this.FooterRightCell,this.ModifiedDate});
BookingPrintout.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
Id = json['Id'];
Name = json['Name'];
HeaderLeftCell = json['HeaderLeftCell'];
HeaderMiddleCell = json['HeaderMiddleCell'];
HeaderRightCell = json['HeaderRightCell'];
BodyCell = json['BodyCell'];
FooterLeftCell = json['FooterLeftCell'];
FooterMiddleCell = json['FooterMiddleCell'];
FooterRightCell = json['FooterRightCell'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'Id': Id,
'Name': Name,
'HeaderLeftCell': HeaderLeftCell,
'HeaderMiddleCell': HeaderMiddleCell,
'HeaderRightCell': HeaderRightCell,
'BodyCell': BodyCell,
'FooterLeftCell': FooterLeftCell,
'FooterMiddleCell': FooterMiddleCell,
'FooterRightCell': FooterRightCell,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "BookingPrintout";
TypeContext? context = _ctx;
}
// @ValidateRequest(Validator="IsAuthenticated")
class ReportQuery extends QueryDb2<BookingPrintout,BookingPrintoutQueryResponse> 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;
ReportQuery({this.CompanyId});
ReportQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId
});
getTypeName() => "ReportQuery";
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: 'api.bokamera.se', types: <String, TypeInfo> {
'BookingPrintoutQueryResponse': TypeInfo(TypeOf.Class, create:() => BookingPrintoutQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'BookingPrintout': TypeInfo(TypeOf.Class, create:() => BookingPrintout()),
'ReportQuery': TypeInfo(TypeOf.Class, create:() => ReportQuery()),
'List<BookingPrintoutQueryResponse>': TypeInfo(TypeOf.Class, create:() => <BookingPrintoutQueryResponse>[]),
'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 /bookings/reports/ HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
HeaderLeftCell: String,
HeaderMiddleCell: String,
HeaderRightCell: String,
BodyCell: String,
FooterLeftCell: String,
FooterMiddleCell: String,
FooterRightCell: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}