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

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class RefreshmentsOverviewRequest
    {
        public Integer ownerId = null;
        public Integer seriesId = null;
        public Date fromUtc = null;
        public Date toUtc = null;
        public Date compareFromUtc = null;
        public Date compareToUtc = null;
        public String bucket = null;
        public Integer topEventsLimit = null;
        public Integer recentOrdersLimit = null;
        
        public Integer getOwnerId() { return ownerId; }
        public RefreshmentsOverviewRequest setOwnerId(Integer value) { this.ownerId = value; return this; }
        public Integer getSeriesId() { return seriesId; }
        public RefreshmentsOverviewRequest setSeriesId(Integer value) { this.seriesId = value; return this; }
        public Date getFromUtc() { return fromUtc; }
        public RefreshmentsOverviewRequest setFromUtc(Date value) { this.fromUtc = value; return this; }
        public Date getToUtc() { return toUtc; }
        public RefreshmentsOverviewRequest setToUtc(Date value) { this.toUtc = value; return this; }
        public Date getCompareFromUtc() { return compareFromUtc; }
        public RefreshmentsOverviewRequest setCompareFromUtc(Date value) { this.compareFromUtc = value; return this; }
        public Date getCompareToUtc() { return compareToUtc; }
        public RefreshmentsOverviewRequest setCompareToUtc(Date value) { this.compareToUtc = value; return this; }
        public String getBucket() { return bucket; }
        public RefreshmentsOverviewRequest setBucket(String value) { this.bucket = value; return this; }
        public Integer getTopEventsLimit() { return topEventsLimit; }
        public RefreshmentsOverviewRequest setTopEventsLimit(Integer value) { this.topEventsLimit = value; return this; }
        public Integer getRecentOrdersLimit() { return recentOrdersLimit; }
        public RefreshmentsOverviewRequest setRecentOrdersLimit(Integer value) { this.recentOrdersLimit = value; return this; }
    }

    public static class RefreshmentsOverviewResult
    {
        public RefreshmentsKpis current = null;
        public RefreshmentsKpis previous = null;
        public RefreshmentsDeltas delta = null;
        public ArrayList<SalesTrendBucket> trend = null;
        public ArrayList<SalesTrendBucket> previousTrend = null;
        public ArrayList<RefreshmentsProduct> products = null;
        public ArrayList<RefreshmentsEventRow> events = null;
        public ArrayList<SalesHourBucket> byHourOfDay = null;
        public ArrayList<SalesDowBucket> byDayOfWeek = null;
        public ArrayList<RefreshmentsPaymentMethodRow> byPaymentMethod = null;
        public ArrayList<RefreshmentsRecentOrder> recentOrders = null;
        public Boolean hasAnyDataEver = null;
        public String bucket = null;
        public Date freshnessUtc = null;
        public Integer statusCode = null;
        public String message = null;
        
        public RefreshmentsKpis getCurrent() { return current; }
        public RefreshmentsOverviewResult setCurrent(RefreshmentsKpis value) { this.current = value; return this; }
        public RefreshmentsKpis getPrevious() { return previous; }
        public RefreshmentsOverviewResult setPrevious(RefreshmentsKpis value) { this.previous = value; return this; }
        public RefreshmentsDeltas getDelta() { return delta; }
        public RefreshmentsOverviewResult setDelta(RefreshmentsDeltas value) { this.delta = value; return this; }
        public ArrayList<SalesTrendBucket> getTrend() { return trend; }
        public RefreshmentsOverviewResult setTrend(ArrayList<SalesTrendBucket> value) { this.trend = value; return this; }
        public ArrayList<SalesTrendBucket> getPreviousTrend() { return previousTrend; }
        public RefreshmentsOverviewResult setPreviousTrend(ArrayList<SalesTrendBucket> value) { this.previousTrend = value; return this; }
        public ArrayList<RefreshmentsProduct> getProducts() { return products; }
        public RefreshmentsOverviewResult setProducts(ArrayList<RefreshmentsProduct> value) { this.products = value; return this; }
        public ArrayList<RefreshmentsEventRow> getEvents() { return events; }
        public RefreshmentsOverviewResult setEvents(ArrayList<RefreshmentsEventRow> value) { this.events = value; return this; }
        public ArrayList<SalesHourBucket> getByHourOfDay() { return byHourOfDay; }
        public RefreshmentsOverviewResult setByHourOfDay(ArrayList<SalesHourBucket> value) { this.byHourOfDay = value; return this; }
        public ArrayList<SalesDowBucket> getByDayOfWeek() { return byDayOfWeek; }
        public RefreshmentsOverviewResult setByDayOfWeek(ArrayList<SalesDowBucket> value) { this.byDayOfWeek = value; return this; }
        public ArrayList<RefreshmentsPaymentMethodRow> getByPaymentMethod() { return byPaymentMethod; }
        public RefreshmentsOverviewResult setByPaymentMethod(ArrayList<RefreshmentsPaymentMethodRow> value) { this.byPaymentMethod = value; return this; }
        public ArrayList<RefreshmentsRecentOrder> getRecentOrders() { return recentOrders; }
        public RefreshmentsOverviewResult setRecentOrders(ArrayList<RefreshmentsRecentOrder> value) { this.recentOrders = value; return this; }
        public Boolean isHasAnyDataEver() { return hasAnyDataEver; }
        public RefreshmentsOverviewResult setHasAnyDataEver(Boolean value) { this.hasAnyDataEver = value; return this; }
        public String getBucket() { return bucket; }
        public RefreshmentsOverviewResult setBucket(String value) { this.bucket = value; return this; }
        public Date getFreshnessUtc() { return freshnessUtc; }
        public RefreshmentsOverviewResult setFreshnessUtc(Date value) { this.freshnessUtc = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public RefreshmentsOverviewResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public RefreshmentsOverviewResult setMessage(String value) { this.message = value; return this; }
    }

    public static class RefreshmentsKpis
    {
        public BigDecimal revenue = null;
        public BigDecimal refunded = null;
        public Integer units = null;
        public Integer orders = null;
        public BigDecimal aov = null;
        public BigDecimal unitsPerOrder = null;
        public Integer attendance = null;
        public BigDecimal perCap = null;
        
        public BigDecimal getRevenue() { return revenue; }
        public RefreshmentsKpis setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public BigDecimal getRefunded() { return refunded; }
        public RefreshmentsKpis setRefunded(BigDecimal value) { this.refunded = value; return this; }
        public Integer getUnits() { return units; }
        public RefreshmentsKpis setUnits(Integer value) { this.units = value; return this; }
        public Integer getOrders() { return orders; }
        public RefreshmentsKpis setOrders(Integer value) { this.orders = value; return this; }
        public BigDecimal getAov() { return aov; }
        public RefreshmentsKpis setAov(BigDecimal value) { this.aov = value; return this; }
        public BigDecimal getUnitsPerOrder() { return unitsPerOrder; }
        public RefreshmentsKpis setUnitsPerOrder(BigDecimal value) { this.unitsPerOrder = value; return this; }
        public Integer getAttendance() { return attendance; }
        public RefreshmentsKpis setAttendance(Integer value) { this.attendance = value; return this; }
        public BigDecimal getPerCap() { return perCap; }
        public RefreshmentsKpis setPerCap(BigDecimal value) { this.perCap = value; return this; }
    }

    public static class RefreshmentsDeltas
    {
        public KpiDelta revenue = null;
        public KpiDelta refunded = null;
        public KpiDelta units = null;
        public KpiDelta orders = null;
        public KpiDelta aov = null;
        public KpiDelta perCap = null;
        
        public KpiDelta getRevenue() { return revenue; }
        public RefreshmentsDeltas setRevenue(KpiDelta value) { this.revenue = value; return this; }
        public KpiDelta getRefunded() { return refunded; }
        public RefreshmentsDeltas setRefunded(KpiDelta value) { this.refunded = value; return this; }
        public KpiDelta getUnits() { return units; }
        public RefreshmentsDeltas setUnits(KpiDelta value) { this.units = value; return this; }
        public KpiDelta getOrders() { return orders; }
        public RefreshmentsDeltas setOrders(KpiDelta value) { this.orders = value; return this; }
        public KpiDelta getAov() { return aov; }
        public RefreshmentsDeltas setAov(KpiDelta value) { this.aov = value; return this; }
        public KpiDelta getPerCap() { return perCap; }
        public RefreshmentsDeltas setPerCap(KpiDelta value) { this.perCap = value; return this; }
    }

    public static class KpiDelta
    {
        public BigDecimal abs = null;
        public Double pct = null;
        public String dir = null;
        
        public BigDecimal getAbs() { return abs; }
        public KpiDelta setAbs(BigDecimal value) { this.abs = value; return this; }
        public Double getPct() { return pct; }
        public KpiDelta setPct(Double value) { this.pct = value; return this; }
        public String getDir() { return dir; }
        public KpiDelta setDir(String value) { this.dir = value; return this; }
    }

    public static class SalesTrendBucket
    {
        public Date bucket = null;
        public BigDecimal revenue = null;
        public Integer tickets = null;
        
        public Date getBucket() { return bucket; }
        public SalesTrendBucket setBucket(Date value) { this.bucket = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public SalesTrendBucket setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getTickets() { return tickets; }
        public SalesTrendBucket setTickets(Integer value) { this.tickets = value; return this; }
    }

    public static class RefreshmentsProduct
    {
        public Integer ticketTypeId = null;
        public String name = null;
        public Integer units = null;
        public BigDecimal revenue = null;
        public Integer orders = null;
        public Date lastSoldAt = null;
        
        public Integer getTicketTypeId() { return ticketTypeId; }
        public RefreshmentsProduct setTicketTypeId(Integer value) { this.ticketTypeId = value; return this; }
        public String getName() { return name; }
        public RefreshmentsProduct setName(String value) { this.name = value; return this; }
        public Integer getUnits() { return units; }
        public RefreshmentsProduct setUnits(Integer value) { this.units = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public RefreshmentsProduct setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getOrders() { return orders; }
        public RefreshmentsProduct setOrders(Integer value) { this.orders = value; return this; }
        public Date getLastSoldAt() { return lastSoldAt; }
        public RefreshmentsProduct setLastSoldAt(Date value) { this.lastSoldAt = value; return this; }
    }

    public static class RefreshmentsEventRow
    {
        public Integer eventId = null;
        public String eventName = null;
        public Date eventDate = null;
        public BigDecimal revenue = null;
        public Integer units = null;
        public Integer orders = null;
        public Integer attendance = null;
        public BigDecimal perCap = null;
        
        public Integer getEventId() { return eventId; }
        public RefreshmentsEventRow setEventId(Integer value) { this.eventId = value; return this; }
        public String getEventName() { return eventName; }
        public RefreshmentsEventRow setEventName(String value) { this.eventName = value; return this; }
        public Date getEventDate() { return eventDate; }
        public RefreshmentsEventRow setEventDate(Date value) { this.eventDate = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public RefreshmentsEventRow setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getUnits() { return units; }
        public RefreshmentsEventRow setUnits(Integer value) { this.units = value; return this; }
        public Integer getOrders() { return orders; }
        public RefreshmentsEventRow setOrders(Integer value) { this.orders = value; return this; }
        public Integer getAttendance() { return attendance; }
        public RefreshmentsEventRow setAttendance(Integer value) { this.attendance = value; return this; }
        public BigDecimal getPerCap() { return perCap; }
        public RefreshmentsEventRow setPerCap(BigDecimal value) { this.perCap = value; return this; }
    }

    public static class SalesHourBucket
    {
        public Integer hour = null;
        public BigDecimal revenue = null;
        public Integer orders = null;
        public Integer tickets = null;
        
        public Integer getHour() { return hour; }
        public SalesHourBucket setHour(Integer value) { this.hour = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public SalesHourBucket setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getOrders() { return orders; }
        public SalesHourBucket setOrders(Integer value) { this.orders = value; return this; }
        public Integer getTickets() { return tickets; }
        public SalesHourBucket setTickets(Integer value) { this.tickets = value; return this; }
    }

    public static class SalesDowBucket
    {
        public Integer dow = null;
        public BigDecimal revenue = null;
        public Integer orders = null;
        public Integer tickets = null;
        
        public Integer getDow() { return dow; }
        public SalesDowBucket setDow(Integer value) { this.dow = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public SalesDowBucket setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getOrders() { return orders; }
        public SalesDowBucket setOrders(Integer value) { this.orders = value; return this; }
        public Integer getTickets() { return tickets; }
        public SalesDowBucket setTickets(Integer value) { this.tickets = value; return this; }
    }

    public static class RefreshmentsPaymentMethodRow
    {
        public String paymentMethodId = null;
        public BigDecimal revenue = null;
        public Integer units = null;
        public Integer orders = null;
        
        public String getPaymentMethodId() { return paymentMethodId; }
        public RefreshmentsPaymentMethodRow setPaymentMethodId(String value) { this.paymentMethodId = value; return this; }
        public BigDecimal getRevenue() { return revenue; }
        public RefreshmentsPaymentMethodRow setRevenue(BigDecimal value) { this.revenue = value; return this; }
        public Integer getUnits() { return units; }
        public RefreshmentsPaymentMethodRow setUnits(Integer value) { this.units = value; return this; }
        public Integer getOrders() { return orders; }
        public RefreshmentsPaymentMethodRow setOrders(Integer value) { this.orders = value; return this; }
    }

    public static class RefreshmentsRecentOrder
    {
        public Integer ticketId = null;
        public Date createdAt = null;
        public String eventName = null;
        public BigDecimal amount = null;
        public Integer units = null;
        public String paymentMethodId = null;
        
        public Integer getTicketId() { return ticketId; }
        public RefreshmentsRecentOrder setTicketId(Integer value) { this.ticketId = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public RefreshmentsRecentOrder setCreatedAt(Date value) { this.createdAt = value; return this; }
        public String getEventName() { return eventName; }
        public RefreshmentsRecentOrder setEventName(String value) { this.eventName = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public RefreshmentsRecentOrder setAmount(BigDecimal value) { this.amount = value; return this; }
        public Integer getUnits() { return units; }
        public RefreshmentsRecentOrder setUnits(Integer value) { this.units = value; return this; }
        public String getPaymentMethodId() { return paymentMethodId; }
        public RefreshmentsRecentOrder setPaymentMethodId(String value) { this.paymentMethodId = value; return this; }
    }

}

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