BokaMera.API.Host

StatisticQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/statistics


export class BookedByDay
{
    public Date: string;
    public Value: number;

    public constructor(init?: Partial<BookedByDay>) { (Object as any).assign(this, init); }
}

export class StatisticQueryResponse
{
    public NumberOfOccuringBookings: number;
    public NumberOfCanceledBookings: number;
    public NumberOfCreatedBookings: number;
    public NumberOfCreatedCustomers: number;
    public OccuringBookingsByDay: BookedByDay[];
    public CanceledBookingsByDay: BookedByDay[];
    public CreatedBookingsByDay: BookedByDay[];
    public CreatedCustomersByDay: BookedByDay[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<StatisticQueryResponse>) { (Object as any).assign(this, init); }
}

// @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")
export class StatisticQuery implements ICompany
{
    /** @description 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 CompanyId: string;

    /** @description Start of interval to get bookings and customers */
    // @ApiMember(Description="Start of interval to get bookings and customers", IsRequired=true, ParameterType="query")
    // @Required()
    public From: string;

    /** @description End of interval to get bookings and customers */
    // @ApiMember(Description="End of interval to get bookings and customers", IsRequired=true, ParameterType="query")
    public To: string;

    /** @description 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 IncludeOccuringBookingsByDay: boolean;

    /** @description 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 IncludeBookingsCanceledByDay: boolean;

    /** @description 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 IncludeCreatedBookingsByDay: boolean;

    /** @description 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 IncludeCreatedCustomersByDay: boolean;

    public constructor(init?: Partial<StatisticQuery>) { (Object as any).assign(this, init); }
}

TypeScript StatisticQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}