Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /statistics |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | Yes | Enter the company id, if blank company id and you are an admin, your company id will be used. |
From | query | DateTime | Yes | Start of interval to get bookings and customers |
To | query | DateTime | Yes | End of interval to get bookings and customers |
IncludeOccuringBookingsByDay | query | bool | No | Set true if you want to include booked events by day |
IncludeBookingsCanceledByDay | query | bool | No | Set true if you want to include canceled booked events by day |
IncludeCreatedBookingsByDay | query | bool | No | Set true if you want to include booking created by day |
IncludeCreatedCustomersByDay | query | bool | No | Set true if you want to include customers created by day |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NumberOfOccuringBookings | form | int | No | |
NumberOfCanceledBookings | form | int | No | |
NumberOfCreatedBookings | form | int | No | |
NumberOfCreatedCustomers | form | int | No | |
OccuringBookingsByDay | form | List<BookedByDay> | No | |
CanceledBookingsByDay | form | List<BookedByDay> | No | |
CreatedBookingsByDay | form | List<BookedByDay> | No | |
CreatedCustomersByDay | form | List<BookedByDay> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Date | form | DateTime | No | |
Value | form | int | No |
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>