BokaMera.API.Host

<back to all web services

StatisticQuery

using System;
using System.IO;
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 canceled booked events by day
        ///</summary>
        [ApiMember(Description="Set true if you want to include canceled booked events by day", ParameterType="query")]
        public virtual bool IncludeBookingsCanceledByDay { 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 virtual int NumberOfOccuringBookings { get; set; }
        public virtual int NumberOfCanceledBookings { 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> CanceledBookingsByDay { get; set; } = [];
        public virtual List<BookedByDay> CreatedBookingsByDay { get; set; } = [];
        public virtual List<BookedByDay> CreatedCustomersByDay { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# StatisticQuery DTOs

GET /statistics HTTP/1.1 
Host: api.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>