| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ownerId: 0,
seriesId: 0,
fromUtc: 0001-01-01,
toUtc: 0001-01-01,
compareFromUtc: 0001-01-01,
compareToUtc: 0001-01-01,
bucket: String,
topEventsLimit: 0,
recentOrdersLimit: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
revenue: 0,
tickets: 0
}
],
previousTrend:
[
{
bucket: 0001-01-01,
revenue: 0,
tickets: 0
}
],
products:
[
{
ticketTypeId: 0,
name: String,
units: 0,
revenue: 0,
orders: 0,
lastSoldAt: 0001-01-01
}
],
events:
[
{
eventId: 0,
eventName: String,
eventDate: 0001-01-01,
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-01,
eventName: String,
amount: 0,
units: 0,
paymentMethodId: String
}
],
hasAnyDataEver: False,
bucket: String,
freshnessUtc: 0001-01-01,
statusCode: 0,
message: String
}