| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /statistics |
|---|
import Foundation
import ServiceStack
// @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")
public class StatisticQuery : ICompany, Codable
{
/**
* 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")
public var companyId:String?
/**
* Start of interval to get bookings and customers
*/
// @ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")
// @Required()
public var from:Date?
/**
* End of interval to get bookings and customers
*/
// @ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")
public var to:Date
/**
* 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")
public var includeOccuringBookingsByDay:Bool
/**
* 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")
public var includeBookingsCanceledByDay:Bool
/**
* 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")
public var includeCreatedBookingsByDay:Bool
/**
* 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")
public var includeCreatedCustomersByDay:Bool
required public init(){}
}
public class StatisticQueryResponse : Codable
{
public var numberOfOccuringBookings:Int
public var numberOfCanceledBookings:Int
public var numberOfCreatedBookings:Int
public var numberOfCreatedCustomers:Int
public var occuringBookingsByDay:[BookedByDay] = []
public var canceledBookingsByDay:[BookedByDay] = []
public var createdBookingsByDay:[BookedByDay] = []
public var createdCustomersByDay:[BookedByDay] = []
public var responseStatus:ResponseStatus
required public init(){}
}
public class BookedByDay : Codable
{
public var date:Date
public var value:Int
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}