| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| 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
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>