TicketUserServices

SalesOverviewRequest

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

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class KpiDelta
            Public Overridable Property Abs As Decimal
            Public Overridable Property Pct As Nullable(Of Double)
            Public Overridable Property Dir As String
        End Class

        Public Partial Class SalesDeltas
            Public Overridable Property GrossNet As KpiDelta
            Public Overridable Property Refunded As KpiDelta
            Public Overridable Property TicketsAllReal As KpiDelta
            Public Overridable Property TicketsPaid As KpiDelta
            Public Overridable Property Orders As KpiDelta
            Public Overridable Property Aov As KpiDelta
        End Class

        Public Partial Class SalesDowBucket
            Public Overridable Property Dow As Integer
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Orders As Integer
            Public Overridable Property Tickets As Integer
        End Class

        Public Partial Class SalesHourBucket
            Public Overridable Property Hour As Integer
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Orders As Integer
            Public Overridable Property Tickets As Integer
        End Class

        Public Partial Class SalesKpis
            Public Overridable Property GrossNet As Decimal
            Public Overridable Property Refunded As Decimal
            Public Overridable Property TicketsAllReal As Integer
            Public Overridable Property TicketsPaid As Integer
            Public Overridable Property Orders As Integer
            Public Overridable Property Aov As Decimal
        End Class

        Public Partial Class SalesOverviewRequest
            Public Sub New()
                AdditionalOwnerIds = New Integer(){}
            End Sub

            Public Overridable Property EventOwnerId As Integer
            Public Overridable Property AdditionalOwnerIds As Integer()
            Public Overridable Property EventId As Nullable(Of Integer)
            Public Overridable Property FromUtc As Date
            Public Overridable Property ToUtc As Date
            Public Overridable Property CompareFromUtc As Nullable(Of Date)
            Public Overridable Property CompareToUtc As Nullable(Of Date)
            Public Overridable Property Bucket As String
            Public Overridable Property TopEventsLimit As Integer
            Public Overridable Property RecentOrdersLimit As Integer
        End Class

        Public Partial Class SalesOverviewResult
            Public Sub New()
                Trend = New List(Of SalesTrendBucket)
                PreviousTrend = New List(Of SalesTrendBucket)
                TopEvents = New List(Of SalesTopEvent)
                RecentOrders = New List(Of SalesRecentOrder)
                ByHourOfDay = New List(Of SalesHourBucket)
                ByDayOfWeek = New List(Of SalesDowBucket)
                TopProducts = New List(Of SalesProduct)
                Owners = New List(Of Integer)
            End Sub

            Public Overridable Property Current As SalesKpis
            Public Overridable Property Previous As SalesKpis
            Public Overridable Property Delta As SalesDeltas
            Public Overridable Property Trend As List(Of SalesTrendBucket)
            Public Overridable Property PreviousTrend As List(Of SalesTrendBucket)
            Public Overridable Property TopEvents As List(Of SalesTopEvent)
            Public Overridable Property RecentOrders As List(Of SalesRecentOrder)
            Public Overridable Property ByHourOfDay As List(Of SalesHourBucket)
            Public Overridable Property ByDayOfWeek As List(Of SalesDowBucket)
            Public Overridable Property TopProducts As List(Of SalesProduct)
            Public Overridable Property HasAnyDataEver As Boolean
            Public Overridable Property Owners As List(Of Integer)
            Public Overridable Property Bucket As String
            Public Overridable Property FreshnessUtc As Date
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class SalesProduct
            Public Overridable Property TicketName As String
            Public Overridable Property Tickets As Integer
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Orders As Integer
        End Class

        Public Partial Class SalesRecentOrder
            Public Overridable Property TicketId As Integer
            Public Overridable Property CreatedAt As Date
            Public Overridable Property EventName As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property TicketCount As Integer
            Public Overridable Property BuyerName As String
        End Class

        Public Partial Class SalesTopEvent
            Public Overridable Property EventId As Integer
            Public Overridable Property EventName As String
            Public Overridable Property EventDate As Nullable(Of Date)
            Public Overridable Property GrossNet As Decimal
            Public Overridable Property PaidTickets As Integer
            Public Overridable Property RealTickets As Integer
            Public Overridable Property Orders As Integer
        End Class

        Public Partial Class SalesTrendBucket
            Public Overridable Property Bucket As Date
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Tickets As Integer
        End Class
    End Namespace
End Namespace

VB.NET SalesOverviewRequest 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/overview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesOverviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AdditionalOwnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </AdditionalOwnerIds>
  <Bucket>String</Bucket>
  <CompareFromUtc>0001-01-01T00:00:00</CompareFromUtc>
  <CompareToUtc>0001-01-01T00:00:00</CompareToUtc>
  <EventId>0</EventId>
  <EventOwnerId>0</EventOwnerId>
  <FromUtc>0001-01-01T00:00:00</FromUtc>
  <RecentOrdersLimit>0</RecentOrdersLimit>
  <ToUtc>0001-01-01T00:00:00</ToUtc>
  <TopEventsLimit>0</TopEventsLimit>
</SalesOverviewRequest>

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

<SalesOverviewResult 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>
  <Current>
    <Aov>0</Aov>
    <GrossNet>0</GrossNet>
    <Orders>0</Orders>
    <Refunded>0</Refunded>
    <TicketsAllReal>0</TicketsAllReal>
    <TicketsPaid>0</TicketsPaid>
  </Current>
  <Delta>
    <Aov>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Aov>
    <GrossNet>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </GrossNet>
    <Orders>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Orders>
    <Refunded>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </Refunded>
    <TicketsAllReal>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </TicketsAllReal>
    <TicketsPaid>
      <Abs>0</Abs>
      <Dir>String</Dir>
      <Pct>0</Pct>
    </TicketsPaid>
  </Delta>
  <FreshnessUtc>0001-01-01T00:00:00</FreshnessUtc>
  <HasAnyDataEver>false</HasAnyDataEver>
  <Message>String</Message>
  <Owners xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Owners>
  <Previous>
    <Aov>0</Aov>
    <GrossNet>0</GrossNet>
    <Orders>0</Orders>
    <Refunded>0</Refunded>
    <TicketsAllReal>0</TicketsAllReal>
    <TicketsPaid>0</TicketsPaid>
  </Previous>
  <PreviousTrend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </PreviousTrend>
  <RecentOrders>
    <SalesRecentOrder>
      <Amount>0</Amount>
      <BuyerName>String</BuyerName>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <EventName>String</EventName>
      <TicketCount>0</TicketCount>
      <TicketId>0</TicketId>
    </SalesRecentOrder>
  </RecentOrders>
  <StatusCode>0</StatusCode>
  <TopEvents>
    <SalesTopEvent>
      <EventDate>0001-01-01T00:00:00</EventDate>
      <EventId>0</EventId>
      <EventName>String</EventName>
      <GrossNet>0</GrossNet>
      <Orders>0</Orders>
      <PaidTickets>0</PaidTickets>
      <RealTickets>0</RealTickets>
    </SalesTopEvent>
  </TopEvents>
  <TopProducts>
    <SalesProduct>
      <Orders>0</Orders>
      <Revenue>0</Revenue>
      <TicketName>String</TicketName>
      <Tickets>0</Tickets>
    </SalesProduct>
  </TopProducts>
  <Trend>
    <SalesTrendBucket>
      <Bucket>0001-01-01T00:00:00</Bucket>
      <Revenue>0</Revenue>
      <Tickets>0</Tickets>
    </SalesTrendBucket>
  </Trend>
</SalesOverviewResult>