| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /statistics |
|---|
import 'package:servicestack/servicestack.dart';
class BookedByDay implements IConvertible
{
DateTime? Date;
int? Value;
BookedByDay({this.Date,this.Value});
BookedByDay.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Date = JsonConverters.fromJson(json['Date'],'DateTime',context!);
Value = json['Value'];
return this;
}
Map<String, dynamic> toJson() => {
'Date': JsonConverters.toJson(Date,'DateTime',context!),
'Value': Value
};
getTypeName() => "BookedByDay";
TypeContext? context = _ctx;
}
class StatisticQueryResponse implements IConvertible
{
int? NumberOfOccuringBookings;
int? NumberOfCanceledBookings;
int? NumberOfCreatedBookings;
int? NumberOfCreatedCustomers;
List<BookedByDay>? OccuringBookingsByDay;
List<BookedByDay>? CanceledBookingsByDay;
List<BookedByDay>? CreatedBookingsByDay;
List<BookedByDay>? CreatedCustomersByDay;
ResponseStatus? ResponseStatus;
StatisticQueryResponse({this.NumberOfOccuringBookings,this.NumberOfCanceledBookings,this.NumberOfCreatedBookings,this.NumberOfCreatedCustomers,this.OccuringBookingsByDay,this.CanceledBookingsByDay,this.CreatedBookingsByDay,this.CreatedCustomersByDay,this.ResponseStatus});
StatisticQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
NumberOfOccuringBookings = json['NumberOfOccuringBookings'];
NumberOfCanceledBookings = json['NumberOfCanceledBookings'];
NumberOfCreatedBookings = json['NumberOfCreatedBookings'];
NumberOfCreatedCustomers = json['NumberOfCreatedCustomers'];
OccuringBookingsByDay = JsonConverters.fromJson(json['OccuringBookingsByDay'],'List<BookedByDay>',context!);
CanceledBookingsByDay = JsonConverters.fromJson(json['CanceledBookingsByDay'],'List<BookedByDay>',context!);
CreatedBookingsByDay = JsonConverters.fromJson(json['CreatedBookingsByDay'],'List<BookedByDay>',context!);
CreatedCustomersByDay = JsonConverters.fromJson(json['CreatedCustomersByDay'],'List<BookedByDay>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'NumberOfOccuringBookings': NumberOfOccuringBookings,
'NumberOfCanceledBookings': NumberOfCanceledBookings,
'NumberOfCreatedBookings': NumberOfCreatedBookings,
'NumberOfCreatedCustomers': NumberOfCreatedCustomers,
'OccuringBookingsByDay': JsonConverters.toJson(OccuringBookingsByDay,'List<BookedByDay>',context!),
'CanceledBookingsByDay': JsonConverters.toJson(CanceledBookingsByDay,'List<BookedByDay>',context!),
'CreatedBookingsByDay': JsonConverters.toJson(CreatedBookingsByDay,'List<BookedByDay>',context!),
'CreatedCustomersByDay': JsonConverters.toJson(CreatedCustomersByDay,'List<BookedByDay>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "StatisticQueryResponse";
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 StatisticQuery implements ICompany, IConvertible
{
/**
* Enter the company id, if blank company id and you are an admin, your company id will be used.
*/
// @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true, ParameterType="query")
String? CompanyId;
/**
* Start of interval to get bookings and customers
*/
// @ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")
// @Required()
DateTime? From;
/**
* End of interval to get bookings and customers
*/
// @ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")
DateTime? To;
/**
* Set true if you want to include booked events by day
*/
// @ApiMember(Description="Set true if you want to include booked events by day", ParameterType="query")
bool? IncludeOccuringBookingsByDay;
/**
* Set true if you want to include canceled booked events by day
*/
// @ApiMember(Description="Set true if you want to include canceled booked events by day", ParameterType="query")
bool? IncludeBookingsCanceledByDay;
/**
* Set true if you want to include booking created by day
*/
// @ApiMember(Description="Set true if you want to include booking created by day", ParameterType="query")
bool? IncludeCreatedBookingsByDay;
/**
* Set true if you want to include customers created by day
*/
// @ApiMember(Description="Set true if you want to include customers created by day", ParameterType="query")
bool? IncludeCreatedCustomersByDay;
StatisticQuery({this.CompanyId,this.From,this.To,this.IncludeOccuringBookingsByDay,this.IncludeBookingsCanceledByDay,this.IncludeCreatedBookingsByDay,this.IncludeCreatedCustomersByDay});
StatisticQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
From = JsonConverters.fromJson(json['From'],'DateTime',context!);
To = JsonConverters.fromJson(json['To'],'DateTime',context!);
IncludeOccuringBookingsByDay = json['IncludeOccuringBookingsByDay'];
IncludeBookingsCanceledByDay = json['IncludeBookingsCanceledByDay'];
IncludeCreatedBookingsByDay = json['IncludeCreatedBookingsByDay'];
IncludeCreatedCustomersByDay = json['IncludeCreatedCustomersByDay'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'From': JsonConverters.toJson(From,'DateTime',context!),
'To': JsonConverters.toJson(To,'DateTime',context!),
'IncludeOccuringBookingsByDay': IncludeOccuringBookingsByDay,
'IncludeBookingsCanceledByDay': IncludeBookingsCanceledByDay,
'IncludeCreatedBookingsByDay': IncludeCreatedBookingsByDay,
'IncludeCreatedCustomersByDay': IncludeCreatedCustomersByDay
};
getTypeName() => "StatisticQuery";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'BookedByDay': TypeInfo(TypeOf.Class, create:() => BookedByDay()),
'StatisticQueryResponse': TypeInfo(TypeOf.Class, create:() => StatisticQueryResponse()),
'List<BookedByDay>': TypeInfo(TypeOf.Class, create:() => <BookedByDay>[]),
'StatisticQuery': TypeInfo(TypeOf.Class, create:() => StatisticQuery()),
});
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.
GET /statistics HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StatisticQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CanceledBookingsByDay>
<BookedByDay>
<Date>0001-01-01T00:00:00</Date>
<Value>0</Value>
</BookedByDay>
</CanceledBookingsByDay>
<CreatedBookingsByDay>
<BookedByDay>
<Date>0001-01-01T00:00:00</Date>
<Value>0</Value>
</BookedByDay>
</CreatedBookingsByDay>
<CreatedCustomersByDay>
<BookedByDay>
<Date>0001-01-01T00:00:00</Date>
<Value>0</Value>
</BookedByDay>
</CreatedCustomersByDay>
<NumberOfCanceledBookings>0</NumberOfCanceledBookings>
<NumberOfCreatedBookings>0</NumberOfCreatedBookings>
<NumberOfCreatedCustomers>0</NumberOfCreatedCustomers>
<NumberOfOccuringBookings>0</NumberOfOccuringBookings>
<OccuringBookingsByDay>
<BookedByDay>
<Date>0001-01-01T00:00:00</Date>
<Value>0</Value>
</BookedByDay>
</OccuringBookingsByDay>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</StatisticQueryResponse>