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

namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RefreshmentsKpis() = 
        member val Revenue:Decimal = new Decimal() with get,set
        member val Refunded:Decimal = new Decimal() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val Orders:Int32 = new Int32() with get,set
        member val Aov:Decimal = new Decimal() with get,set
        member val UnitsPerOrder:Decimal = new Decimal() with get,set
        member val Attendance:Int32 = new Int32() with get,set
        member val PerCap:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type KpiDelta() = 
        member val Abs:Decimal = new Decimal() with get,set
        member val Pct:Nullable<Double> = new Nullable<Double>() with get,set
        member val Dir:String = null with get,set

    [<AllowNullLiteral>]
    type RefreshmentsDeltas() = 
        member val Revenue:KpiDelta = null with get,set
        member val Refunded:KpiDelta = null with get,set
        member val Units:KpiDelta = null with get,set
        member val Orders:KpiDelta = null with get,set
        member val Aov:KpiDelta = null with get,set
        member val PerCap:KpiDelta = null with get,set

    [<AllowNullLiteral>]
    type SalesTrendBucket() = 
        member val Bucket:DateTime = new DateTime() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Tickets:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RefreshmentsProduct() = 
        member val TicketTypeId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Units:Int32 = new Int32() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Orders:Int32 = new Int32() with get,set
        member val LastSoldAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type RefreshmentsEventRow() = 
        member val EventId:Int32 = new Int32() with get,set
        member val EventName:String = null with get,set
        member val EventDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val Orders:Int32 = new Int32() with get,set
        member val Attendance:Int32 = new Int32() with get,set
        member val PerCap:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type SalesHourBucket() = 
        member val Hour:Int32 = new Int32() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Orders:Int32 = new Int32() with get,set
        member val Tickets:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SalesDowBucket() = 
        member val Dow:Int32 = new Int32() with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Orders:Int32 = new Int32() with get,set
        member val Tickets:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RefreshmentsPaymentMethodRow() = 
        member val PaymentMethodId:String = null with get,set
        member val Revenue:Decimal = new Decimal() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val Orders:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RefreshmentsRecentOrder() = 
        member val TicketId:Int32 = new Int32() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val EventName:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Units:Int32 = new Int32() with get,set
        member val PaymentMethodId:String = null with get,set

    [<AllowNullLiteral>]
    type RefreshmentsOverviewResult() = 
        member val Current:RefreshmentsKpis = null with get,set
        member val Previous:RefreshmentsKpis = null with get,set
        member val Delta:RefreshmentsDeltas = null with get,set
        member val Trend:ResizeArray<SalesTrendBucket> = new ResizeArray<SalesTrendBucket>() with get,set
        member val PreviousTrend:ResizeArray<SalesTrendBucket> = new ResizeArray<SalesTrendBucket>() with get,set
        member val Products:ResizeArray<RefreshmentsProduct> = new ResizeArray<RefreshmentsProduct>() with get,set
        member val Events:ResizeArray<RefreshmentsEventRow> = new ResizeArray<RefreshmentsEventRow>() with get,set
        member val ByHourOfDay:ResizeArray<SalesHourBucket> = new ResizeArray<SalesHourBucket>() with get,set
        member val ByDayOfWeek:ResizeArray<SalesDowBucket> = new ResizeArray<SalesDowBucket>() with get,set
        member val ByPaymentMethod:ResizeArray<RefreshmentsPaymentMethodRow> = new ResizeArray<RefreshmentsPaymentMethodRow>() with get,set
        member val RecentOrders:ResizeArray<RefreshmentsRecentOrder> = new ResizeArray<RefreshmentsRecentOrder>() with get,set
        member val HasAnyDataEver:Boolean = new Boolean() with get,set
        member val Bucket:String = null with get,set
        member val FreshnessUtc:DateTime = new DateTime() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type RefreshmentsOverviewRequest() = 
        member val OwnerId:Int32 = new Int32() with get,set
        member val SeriesId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FromUtc:DateTime = new DateTime() with get,set
        member val ToUtc:DateTime = new DateTime() with get,set
        member val CompareFromUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CompareToUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Bucket:String = null with get,set
        member val TopEventsLimit:Int32 = new Int32() with get,set
        member val RecentOrdersLimit:Int32 = new Int32() with get,set

F# 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>