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

"use strict";
export class BookedByDay {
    /** @param {{Date?:string,Value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {number} */
    Value;
}
export class StatisticQueryResponse {
    /** @param {{NumberOfOccuringBookings?:number,NumberOfCanceledBookings?:number,NumberOfCreatedBookings?:number,NumberOfCreatedCustomers?:number,OccuringBookingsByDay?:BookedByDay[],CanceledBookingsByDay?:BookedByDay[],CreatedBookingsByDay?:BookedByDay[],CreatedCustomersByDay?:BookedByDay[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NumberOfOccuringBookings;
    /** @type {number} */
    NumberOfCanceledBookings;
    /** @type {number} */
    NumberOfCreatedBookings;
    /** @type {number} */
    NumberOfCreatedCustomers;
    /** @type {BookedByDay[]} */
    OccuringBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CanceledBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CreatedBookingsByDay = [];
    /** @type {BookedByDay[]} */
    CreatedCustomersByDay = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class StatisticQuery {
    /** @param {{CompanyId?:string,From?:string,To?:string,IncludeOccuringBookingsByDay?:boolean,IncludeBookingsCanceledByDay?:boolean,IncludeCreatedBookingsByDay?:boolean,IncludeCreatedCustomersByDay?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter the company id, if blank company id and you are an admin, your company id will be used. */
    CompanyId;
    /**
     * @type {string}
     * @description Start of interval to get bookings and customers */
    From;
    /**
     * @type {string}
     * @description End of interval to get bookings and customers */
    To;
    /**
     * @type {boolean}
     * @description Set true if you want to include booked events by day */
    IncludeOccuringBookingsByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include canceled booked events by day */
    IncludeBookingsCanceledByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include booking created by day */
    IncludeCreatedBookingsByDay;
    /**
     * @type {boolean}
     * @description Set true if you want to include customers created by day */
    IncludeCreatedCustomersByDay;
}

JavaScript StatisticQuery DTOs

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

HTTP + 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: testapi.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>