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
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 RefreshmentsDeltas
            Public Overridable Property Revenue As KpiDelta
            Public Overridable Property Refunded As KpiDelta
            Public Overridable Property Units As KpiDelta
            Public Overridable Property Orders As KpiDelta
            Public Overridable Property Aov As KpiDelta
            Public Overridable Property PerCap As KpiDelta
        End Class

        Public Partial Class RefreshmentsEventRow
            Public Overridable Property EventId As Integer
            Public Overridable Property EventName As String
            Public Overridable Property EventDate As Nullable(Of Date)
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Units As Integer
            Public Overridable Property Orders As Integer
            Public Overridable Property Attendance As Integer
            Public Overridable Property PerCap As Decimal
        End Class

        Public Partial Class RefreshmentsKpis
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Refunded As Decimal
            Public Overridable Property Units As Integer
            Public Overridable Property Orders As Integer
            Public Overridable Property Aov As Decimal
            Public Overridable Property UnitsPerOrder As Decimal
            Public Overridable Property Attendance As Integer
            Public Overridable Property PerCap As Decimal
        End Class

        Public Partial Class RefreshmentsOverviewRequest
            Public Overridable Property OwnerId As Integer
            Public Overridable Property SeriesId 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 RefreshmentsOverviewResult
            Public Sub New()
                Trend = New List(Of SalesTrendBucket)
                PreviousTrend = New List(Of SalesTrendBucket)
                Products = New List(Of RefreshmentsProduct)
                Events = New List(Of RefreshmentsEventRow)
                ByHourOfDay = New List(Of SalesHourBucket)
                ByDayOfWeek = New List(Of SalesDowBucket)
                ByPaymentMethod = New List(Of RefreshmentsPaymentMethodRow)
                RecentOrders = New List(Of RefreshmentsRecentOrder)
            End Sub

            Public Overridable Property Current As RefreshmentsKpis
            Public Overridable Property Previous As RefreshmentsKpis
            Public Overridable Property Delta As RefreshmentsDeltas
            Public Overridable Property Trend As List(Of SalesTrendBucket)
            Public Overridable Property PreviousTrend As List(Of SalesTrendBucket)
            Public Overridable Property Products As List(Of RefreshmentsProduct)
            Public Overridable Property Events As List(Of RefreshmentsEventRow)
            Public Overridable Property ByHourOfDay As List(Of SalesHourBucket)
            Public Overridable Property ByDayOfWeek As List(Of SalesDowBucket)
            Public Overridable Property ByPaymentMethod As List(Of RefreshmentsPaymentMethodRow)
            Public Overridable Property RecentOrders As List(Of RefreshmentsRecentOrder)
            Public Overridable Property HasAnyDataEver As Boolean
            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 RefreshmentsPaymentMethodRow
            Public Overridable Property PaymentMethodId As String
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Units As Integer
            Public Overridable Property Orders As Integer
        End Class

        Public Partial Class RefreshmentsProduct
            Public Overridable Property TicketTypeId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Units As Integer
            Public Overridable Property Revenue As Decimal
            Public Overridable Property Orders As Integer
            Public Overridable Property LastSoldAt As Nullable(Of Date)
        End Class

        Public Partial Class RefreshmentsRecentOrder
            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 Units As Integer
            Public Overridable Property PaymentMethodId As String
        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 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 RefreshmentsOverviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ownerId":0,"seriesId":0,"fromUtc":"0001-01-01T00:00:00.0000000","toUtc":"0001-01-01T00:00:00.0000000","compareFromUtc":"0001-01-01T00:00:00.0000000","compareToUtc":"0001-01-01T00:00:00.0000000","bucket":"String","topEventsLimit":0,"recentOrdersLimit":0}

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

{"current":{"revenue":0,"refunded":0,"units":0,"orders":0,"aov":0,"unitsPerOrder":0,"attendance":0,"perCap":0},"previous":{"revenue":0,"refunded":0,"units":0,"orders":0,"aov":0,"unitsPerOrder":0,"attendance":0,"perCap":0},"delta":{"revenue":{"abs":0,"pct":0,"dir":"String"},"refunded":{"abs":0,"pct":0,"dir":"String"},"units":{"abs":0,"pct":0,"dir":"String"},"orders":{"abs":0,"pct":0,"dir":"String"},"aov":{"abs":0,"pct":0,"dir":"String"},"perCap":{"abs":0,"pct":0,"dir":"String"}},"trend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"previousTrend":[{"bucket":"0001-01-01T00:00:00.0000000","revenue":0,"tickets":0}],"products":[{"ticketTypeId":0,"name":"String","units":0,"revenue":0,"orders":0,"lastSoldAt":"0001-01-01T00:00:00.0000000"}],"events":[{"eventId":0,"eventName":"String","eventDate":"0001-01-01T00:00:00.0000000","revenue":0,"units":0,"orders":0,"attendance":0,"perCap":0}],"byHourOfDay":[{"hour":0,"revenue":0,"orders":0,"tickets":0}],"byDayOfWeek":[{"dow":0,"revenue":0,"orders":0,"tickets":0}],"byPaymentMethod":[{"paymentMethodId":"String","revenue":0,"units":0,"orders":0}],"recentOrders":[{"ticketId":0,"createdAt":"0001-01-01T00:00:00.0000000","eventName":"String","amount":0,"units":0,"paymentMethodId":"String"}],"hasAnyDataEver":false,"bucket":"String","freshnessUtc":"0001-01-01T00:00:00.0000000","statusCode":0,"message":"String"}