| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /statistics |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookedByDay:
date: datetime.datetime = datetime.datetime(1, 1, 1)
value: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatisticQueryResponse:
number_of_occuring_bookings: int = 0
number_of_canceled_bookings: int = 0
number_of_created_bookings: int = 0
number_of_created_customers: int = 0
occuring_bookings_by_day: Optional[List[BookedByDay]] = None
canceled_bookings_by_day: Optional[List[BookedByDay]] = None
created_bookings_by_day: Optional[List[BookedByDay]] = None
created_customers_by_day: Optional[List[BookedByDay]] = None
response_status: Optional[ResponseStatus] = None
# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatisticQuery(ICompany):
# @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")
company_id: Optional[str] = None
"""
Enter the company id, if blank company id and you are an admin, your company id will be used.
"""
# @ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")
# @Required()
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
"""
Start of interval to get bookings and customers
"""
# @ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")
to: datetime.datetime = datetime.datetime(1, 1, 1)
"""
End of interval to get bookings and customers
"""
# @ApiMember(Description="Set true if you want to include booked events by day", ParameterType="query")
include_occuring_bookings_by_day: bool = False
"""
Set true if you want to include booked events by day
"""
# @ApiMember(Description="Set true if you want to include canceled booked events by day", ParameterType="query")
include_bookings_canceled_by_day: bool = False
"""
Set true if you want to include canceled booked events by day
"""
# @ApiMember(Description="Set true if you want to include booking created by day", ParameterType="query")
include_created_bookings_by_day: bool = False
"""
Set true if you want to include booking created by day
"""
# @ApiMember(Description="Set true if you want to include customers created by day", ParameterType="query")
include_created_customers_by_day: bool = False
"""
Set true if you want to include customers created by day
"""
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>