TicketUserServices

RefreshmentsOverviewRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Sales.Total

The following routes are available for this service:
POST	/sales/refreshments/overview

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class KpiDelta
    {
        public virtual decimal Abs { get; set; }
        public virtual double? Pct { get; set; }
        public virtual string Dir { get; set; }
    }

    public partial class RefreshmentsDeltas
    {
        public virtual KpiDelta Revenue { get; set; }
        public virtual KpiDelta Refunded { get; set; }
        public virtual KpiDelta Units { get; set; }
        public virtual KpiDelta Orders { get; set; }
        public virtual KpiDelta Aov { get; set; }
        public virtual KpiDelta PerCap { get; set; }
    }

    public partial class RefreshmentsEventRow
    {
        public virtual int EventId { get; set; }
        public virtual string EventName { get; set; }
        public virtual DateTime? EventDate { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Units { get; set; }
        public virtual int Orders { get; set; }
        public virtual int Attendance { get; set; }
        public virtual decimal PerCap { get; set; }
    }

    public partial class RefreshmentsKpis
    {
        public virtual decimal Revenue { get; set; }
        public virtual decimal Refunded { get; set; }
        public virtual int Units { get; set; }
        public virtual int Orders { get; set; }
        public virtual decimal Aov { get; set; }
        public virtual decimal UnitsPerOrder { get; set; }
        public virtual int Attendance { get; set; }
        public virtual decimal PerCap { get; set; }
    }

    public partial class RefreshmentsOverviewRequest
    {
        public virtual int OwnerId { get; set; }
        public virtual int? SeriesId { get; set; }
        public virtual DateTime FromUtc { get; set; }
        public virtual DateTime ToUtc { get; set; }
        public virtual DateTime? CompareFromUtc { get; set; }
        public virtual DateTime? CompareToUtc { get; set; }
        public virtual string Bucket { get; set; }
        public virtual int TopEventsLimit { get; set; }
        public virtual int RecentOrdersLimit { get; set; }
    }

    public partial class RefreshmentsOverviewResult
    {
        public RefreshmentsOverviewResult()
        {
            Trend = new List<SalesTrendBucket>{};
            PreviousTrend = new List<SalesTrendBucket>{};
            Products = new List<RefreshmentsProduct>{};
            Events = new List<RefreshmentsEventRow>{};
            ByHourOfDay = new List<SalesHourBucket>{};
            ByDayOfWeek = new List<SalesDowBucket>{};
            ByPaymentMethod = new List<RefreshmentsPaymentMethodRow>{};
            RecentOrders = new List<RefreshmentsRecentOrder>{};
        }

        public virtual RefreshmentsKpis Current { get; set; }
        public virtual RefreshmentsKpis Previous { get; set; }
        public virtual RefreshmentsDeltas Delta { get; set; }
        public virtual List<SalesTrendBucket> Trend { get; set; }
        public virtual List<SalesTrendBucket> PreviousTrend { get; set; }
        public virtual List<RefreshmentsProduct> Products { get; set; }
        public virtual List<RefreshmentsEventRow> Events { get; set; }
        public virtual List<SalesHourBucket> ByHourOfDay { get; set; }
        public virtual List<SalesDowBucket> ByDayOfWeek { get; set; }
        public virtual List<RefreshmentsPaymentMethodRow> ByPaymentMethod { get; set; }
        public virtual List<RefreshmentsRecentOrder> RecentOrders { get; set; }
        public virtual bool HasAnyDataEver { get; set; }
        public virtual string Bucket { get; set; }
        public virtual DateTime FreshnessUtc { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class RefreshmentsPaymentMethodRow
    {
        public virtual string PaymentMethodId { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Units { get; set; }
        public virtual int Orders { get; set; }
    }

    public partial class RefreshmentsProduct
    {
        public virtual int TicketTypeId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Units { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Orders { get; set; }
        public virtual DateTime? LastSoldAt { get; set; }
    }

    public partial class RefreshmentsRecentOrder
    {
        public virtual int TicketId { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual string EventName { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual int Units { get; set; }
        public virtual string PaymentMethodId { get; set; }
    }

    public partial class SalesDowBucket
    {
        public virtual int Dow { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Orders { get; set; }
        public virtual int Tickets { get; set; }
    }

    public partial class SalesHourBucket
    {
        public virtual int Hour { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Orders { get; set; }
        public virtual int Tickets { get; set; }
    }

    public partial class SalesTrendBucket
    {
        public virtual DateTime Bucket { get; set; }
        public virtual decimal Revenue { get; set; }
        public virtual int Tickets { get; set; }
    }

}

C# RefreshmentsOverviewRequest 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.

POST /sales/refreshments/overview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RefreshmentsOverviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Bucket>String</Bucket>
  <CompareFromUtc>0001-01-01T00:00:00</CompareFromUtc>
  <CompareToUtc>0001-01-01T00:00:00</CompareToUtc>
  <FromUtc>0001-01-01T00:00:00</FromUtc>
  <OwnerId>0</OwnerId>
  <RecentOrdersLimit>0</RecentOrdersLimit>
  <SeriesId>0</SeriesId>
  <ToUtc>0001-01-01T00:00:00</ToUtc>
  <TopEventsLimit>0</TopEventsLimit>
</RefreshmentsOverviewRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefreshmentsOverviewResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Bucket>String</Bucket>
  <ByDayOfWeek>
    <SalesDowBucket>
      <Dow>0</Dow>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesDowBucket>
  </ByDayOfWeek>
  <ByHourOfDay>
    <SalesHourBucket>
      <Hour>0</Hour>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesHourBucket>
  </ByHourOfDay>
  <ByPaymentMethod>
    <RefreshmentsPaymentMethodRow>
      <Orders>0</Orders>
      <PaymentMethodId>String</PaymentMethodId>
      <Revenue>0</Revenue>
      <Units>0</Units>
    </RefreshmentsPaymentMethodRow>
  </ByPaymentMethod>
  <Current>
    <Aov>0</Aov>
    <Attendance>0</Attendance>
    <Orders>0</Orders>
    <PerCap>0</PerCap>
    <Refunded>0</Refunded>
    <Revenue>0</Revenue>
    <Units>0</Units>
    <UnitsPerOrder>0</UnitsPerOrder>
  </Current>
  <Delta>
    <Aov>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Aov>
    <Orders>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Orders>
    <PerCap>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </PerCap>
    <Refunded>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Refunded>
    <Revenue>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Revenue>
    <Units>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Units>
  </Delta>
  <Events>
    <RefreshmentsEventRow>
      <Attendance>0</Attendance>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <Orders>0</Orders>
      <PerCap>0</PerCap>
      <Revenue>0</Revenue>
      <Units>0</Units>
    </RefreshmentsEventRow>
  </Events>
  <FreshnessUtc>0001-01-01T00:00:00</FreshnessUtc>
  <HasAnyDataEver>false</HasAnyDataEver>
  <Message>String</Message>
  <Previous>
    <Aov>0</Aov>
    <Attendance>0</Attendance>
    <Orders>0</Orders>
    <PerCap>0</PerCap>
    <Refunded>0</Refunded>
    <Revenue>0</Revenue>
    <Units>0</Units>
    <UnitsPerOrder>0</UnitsPerOrder>
  </Previous>
  <PreviousTrend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </PreviousTrend>
  <Products>
    <RefreshmentsProduct>
      <LastSoldAt>0001-01-01T00:00:00</LastSoldAt>
      <Name>String</Name>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <TicketTypeId>0</TicketTypeId>
      <Units>0</Units>
    </RefreshmentsProduct>
  </Products>
  <RecentOrders>
    <RefreshmentsRecentOrder>
      <Amount>0</Amount>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <EventName>String</EventName>
      <PaymentMethodId>String</PaymentMethodId>
      <TicketId>0</TicketId>
      <Units>0</Units>
    </RefreshmentsRecentOrder>
  </RecentOrders>
  <StatusCode>0</StatusCode>
  <Trend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </Trend>
</RefreshmentsOverviewResult>