BokaMera.API.Host

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

namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BookedByDay() = 
        member val Date:DateTime = new DateTime() with get,set
        member val Value:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type StatisticQueryResponse() = 
        member val NumberOfOccuringBookings:Int32 = new Int32() with get,set
        member val NumberOfCanceledBookings:Int32 = new Int32() with get,set
        member val NumberOfCreatedBookings:Int32 = new Int32() with get,set
        member val NumberOfCreatedCustomers:Int32 = new Int32() with get,set
        member val OccuringBookingsByDay:ResizeArray<BookedByDay> = new ResizeArray<BookedByDay>() with get,set
        member val CanceledBookingsByDay:ResizeArray<BookedByDay> = new ResizeArray<BookedByDay>() with get,set
        member val CreatedBookingsByDay:ResizeArray<BookedByDay> = new ResizeArray<BookedByDay>() with get,set
        member val CreatedCustomersByDay:ResizeArray<BookedByDay> = new ResizeArray<BookedByDay>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<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")>]
    [<AllowNullLiteral>]
    type StatisticQuery() = 
        ///<summary>
        ///Enter the company id, if blank company id and you are an admin, your company id will be used.
        ///</summary>
        [<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Start of interval to get bookings and customers
        ///</summary>
        [<ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")>]
        [<Required>]
        member val From:DateTime = new DateTime() with get,set

        ///<summary>
        ///End of interval to get bookings and customers
        ///</summary>
        [<ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")>]
        member val To:DateTime = new DateTime() with get,set

        ///<summary>
        ///Set true if you want to include booked events by day
        ///</summary>
        [<ApiMember(Description="Set true if you want to include booked events by day", ParameterType="query")>]
        member val IncludeOccuringBookingsByDay:Boolean = new Boolean() with get,set

        ///<summary>
        ///Set true if you want to include canceled booked events by day
        ///</summary>
        [<ApiMember(Description="Set true if you want to include canceled booked events by day", ParameterType="query")>]
        member val IncludeBookingsCanceledByDay:Boolean = new Boolean() with get,set

        ///<summary>
        ///Set true if you want to include booking created by day
        ///</summary>
        [<ApiMember(Description="Set true if you want to include booking created by day", ParameterType="query")>]
        member val IncludeCreatedBookingsByDay:Boolean = new Boolean() with get,set

        ///<summary>
        ///Set true if you want to include customers created by day
        ///</summary>
        [<ApiMember(Description="Set true if you want to include customers created by day", ParameterType="query")>]
        member val IncludeCreatedCustomersByDay:Boolean = new Boolean() with get,set

F# StatisticQuery DTOs

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}