TicketUserServices

<back to all web services

RefreshmentsOverviewRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Sales.Total
The following routes are available for this service:
POST/sales/refreshments/overview
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RefreshmentsOverviewRequest
{
    var ownerId:Int? = null
    var seriesId:Int? = null
    var fromUtc:Date? = null
    var toUtc:Date? = null
    var compareFromUtc:Date? = null
    var compareToUtc:Date? = null
    var bucket:String? = null
    var topEventsLimit:Int? = null
    var recentOrdersLimit:Int? = null
}

open class RefreshmentsOverviewResult
{
    var current:RefreshmentsKpis? = null
    var previous:RefreshmentsKpis? = null
    var delta:RefreshmentsDeltas? = null
    var trend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var previousTrend:ArrayList<SalesTrendBucket> = ArrayList<SalesTrendBucket>()
    var products:ArrayList<RefreshmentsProduct> = ArrayList<RefreshmentsProduct>()
    var events:ArrayList<RefreshmentsEventRow> = ArrayList<RefreshmentsEventRow>()
    var byHourOfDay:ArrayList<SalesHourBucket> = ArrayList<SalesHourBucket>()
    var byDayOfWeek:ArrayList<SalesDowBucket> = ArrayList<SalesDowBucket>()
    var byPaymentMethod:ArrayList<RefreshmentsPaymentMethodRow> = ArrayList<RefreshmentsPaymentMethodRow>()
    var recentOrders:ArrayList<RefreshmentsRecentOrder> = ArrayList<RefreshmentsRecentOrder>()
    var hasAnyDataEver:Boolean? = null
    var bucket:String? = null
    var freshnessUtc:Date? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class RefreshmentsKpis
{
    var revenue:BigDecimal? = null
    var refunded:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
    var aov:BigDecimal? = null
    var unitsPerOrder:BigDecimal? = null
    var attendance:Int? = null
    var perCap:BigDecimal? = null
}

open class RefreshmentsDeltas
{
    var revenue:KpiDelta? = null
    var refunded:KpiDelta? = null
    var units:KpiDelta? = null
    var orders:KpiDelta? = null
    var aov:KpiDelta? = null
    var perCap:KpiDelta? = null
}

open class KpiDelta
{
    var abs:BigDecimal? = null
    var pct:Double? = null
    var dir:String? = null
}

open class SalesTrendBucket
{
    var bucket:Date? = null
    var revenue:BigDecimal? = null
    var tickets:Int? = null
}

open class RefreshmentsProduct
{
    var ticketTypeId:Int? = null
    var name:String? = null
    var units:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var lastSoldAt:Date? = null
}

open class RefreshmentsEventRow
{
    var eventId:Int? = null
    var eventName:String? = null
    var eventDate:Date? = null
    var revenue:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
    var attendance:Int? = null
    var perCap:BigDecimal? = null
}

open class SalesHourBucket
{
    var hour:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class SalesDowBucket
{
    var dow:Int? = null
    var revenue:BigDecimal? = null
    var orders:Int? = null
    var tickets:Int? = null
}

open class RefreshmentsPaymentMethodRow
{
    var paymentMethodId:String? = null
    var revenue:BigDecimal? = null
    var units:Int? = null
    var orders:Int? = null
}

open class RefreshmentsRecentOrder
{
    var ticketId:Int? = null
    var createdAt:Date? = null
    var eventName:String? = null
    var amount:BigDecimal? = null
    var units:Int? = null
    var paymentMethodId:String? = null
}

Kotlin 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>