BokaMera.API.Host

<back to all web services

StatisticQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
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()),
});

Dart StatisticQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NumberOfOccuringBookings: 0,
	NumberOfCanceledBookings: 0,
	NumberOfCreatedBookings: 0,
	NumberOfCreatedCustomers: 0,
	OccuringBookingsByDay: 
	[
		{
			Value: 0
		}
	],
	CanceledBookingsByDay: 
	[
		{
			Value: 0
		}
	],
	CreatedBookingsByDay: 
	[
		{
			Value: 0
		}
	],
	CreatedCustomersByDay: 
	[
		{
			Value: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}