Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /statistics |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class BookedByDay
{
public virtual DateTime Date { get; set; }
public virtual int Value { 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("IsAuthenticated")]
public partial class StatisticQuery
: ICompany
{
///<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")]
public virtual Guid? CompanyId { 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]
public virtual DateTime From { 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")]
public virtual DateTime To { 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")]
public virtual bool IncludeOccuringBookingsByDay { 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")]
public virtual bool IncludeCreatedBookingsByDay { 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")]
public virtual bool IncludeCreatedCustomersByDay { get; set; }
}
public partial class StatisticQueryResponse
{
public StatisticQueryResponse()
{
OccuringBookingsByDay = new List<BookedByDay>{};
CreatedBookingsByDay = new List<BookedByDay>{};
CreatedCustomersByDay = new List<BookedByDay>{};
}
public virtual int NumberOfOccuringBookings { get; set; }
public virtual int NumberOfCreatedBookings { get; set; }
public virtual int NumberOfCreatedCustomers { get; set; }
public virtual List<BookedByDay> OccuringBookingsByDay { get; set; }
public virtual List<BookedByDay> CreatedBookingsByDay { get; set; }
public virtual List<BookedByDay> CreatedCustomersByDay { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /statistics HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { NumberOfOccuringBookings: 0, NumberOfCreatedBookings: 0, NumberOfCreatedCustomers: 0, OccuringBookingsByDay: [ { 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 } } }