| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /statistics |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@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")
open class StatisticQuery : ICompany
{
/**
* 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")
var CompanyId:UUID? = null
/**
* Start of interval to get bookings and customers
*/
@ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")
@Required()
var From:Date? = null
/**
* End of interval to get bookings and customers
*/
@ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")
var To:Date? = null
/**
* 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")
var IncludeOccuringBookingsByDay:Boolean? = null
/**
* 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")
var IncludeBookingsCanceledByDay:Boolean? = null
/**
* 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")
var IncludeCreatedBookingsByDay:Boolean? = null
/**
* 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")
var IncludeCreatedCustomersByDay:Boolean? = null
}
open class StatisticQueryResponse
{
var NumberOfOccuringBookings:Int? = null
var NumberOfCanceledBookings:Int? = null
var NumberOfCreatedBookings:Int? = null
var NumberOfCreatedCustomers:Int? = null
var OccuringBookingsByDay:ArrayList<BookedByDay> = ArrayList<BookedByDay>()
var CanceledBookingsByDay:ArrayList<BookedByDay> = ArrayList<BookedByDay>()
var CreatedBookingsByDay:ArrayList<BookedByDay> = ArrayList<BookedByDay>()
var CreatedCustomersByDay:ArrayList<BookedByDay> = ArrayList<BookedByDay>()
var ResponseStatus:ResponseStatus? = null
}
open class BookedByDay
{
var Date:Date? = null
var Value:Int? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}