| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/refreshments/overview |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
namespace TicketUserServices.ServiceModel
{
public partial class KpiDelta
{
public virtual decimal Abs { get; set; }
public virtual double? Pct { get; set; }
public virtual string Dir { get; set; }
}
public partial class RefreshmentsDeltas
{
public virtual KpiDelta Revenue { get; set; }
public virtual KpiDelta Refunded { get; set; }
public virtual KpiDelta Units { get; set; }
public virtual KpiDelta Orders { get; set; }
public virtual KpiDelta Aov { get; set; }
public virtual KpiDelta PerCap { get; set; }
}
public partial class RefreshmentsEventRow
{
public virtual int EventId { get; set; }
public virtual string EventName { get; set; }
public virtual DateTime? EventDate { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Units { get; set; }
public virtual int Orders { get; set; }
public virtual int Attendance { get; set; }
public virtual decimal PerCap { get; set; }
}
public partial class RefreshmentsKpis
{
public virtual decimal Revenue { get; set; }
public virtual decimal Refunded { get; set; }
public virtual int Units { get; set; }
public virtual int Orders { get; set; }
public virtual decimal Aov { get; set; }
public virtual decimal UnitsPerOrder { get; set; }
public virtual int Attendance { get; set; }
public virtual decimal PerCap { get; set; }
}
public partial class RefreshmentsOverviewRequest
{
public virtual int OwnerId { get; set; }
public virtual int? SeriesId { get; set; }
public virtual DateTime FromUtc { get; set; }
public virtual DateTime ToUtc { get; set; }
public virtual DateTime? CompareFromUtc { get; set; }
public virtual DateTime? CompareToUtc { get; set; }
public virtual string Bucket { get; set; }
public virtual int TopEventsLimit { get; set; }
public virtual int RecentOrdersLimit { get; set; }
}
public partial class RefreshmentsOverviewResult
{
public RefreshmentsOverviewResult()
{
Trend = new List<SalesTrendBucket>{};
PreviousTrend = new List<SalesTrendBucket>{};
Products = new List<RefreshmentsProduct>{};
Events = new List<RefreshmentsEventRow>{};
ByHourOfDay = new List<SalesHourBucket>{};
ByDayOfWeek = new List<SalesDowBucket>{};
ByPaymentMethod = new List<RefreshmentsPaymentMethodRow>{};
RecentOrders = new List<RefreshmentsRecentOrder>{};
}
public virtual RefreshmentsKpis Current { get; set; }
public virtual RefreshmentsKpis Previous { get; set; }
public virtual RefreshmentsDeltas Delta { get; set; }
public virtual List<SalesTrendBucket> Trend { get; set; }
public virtual List<SalesTrendBucket> PreviousTrend { get; set; }
public virtual List<RefreshmentsProduct> Products { get; set; }
public virtual List<RefreshmentsEventRow> Events { get; set; }
public virtual List<SalesHourBucket> ByHourOfDay { get; set; }
public virtual List<SalesDowBucket> ByDayOfWeek { get; set; }
public virtual List<RefreshmentsPaymentMethodRow> ByPaymentMethod { get; set; }
public virtual List<RefreshmentsRecentOrder> RecentOrders { get; set; }
public virtual bool HasAnyDataEver { get; set; }
public virtual string Bucket { get; set; }
public virtual DateTime FreshnessUtc { get; set; }
public virtual int StatusCode { get; set; }
public virtual string Message { get; set; }
}
public partial class RefreshmentsPaymentMethodRow
{
public virtual string PaymentMethodId { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Units { get; set; }
public virtual int Orders { get; set; }
}
public partial class RefreshmentsProduct
{
public virtual int TicketTypeId { get; set; }
public virtual string Name { get; set; }
public virtual int Units { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
public virtual DateTime? LastSoldAt { get; set; }
}
public partial class RefreshmentsRecentOrder
{
public virtual int TicketId { get; set; }
public virtual DateTime CreatedAt { get; set; }
public virtual string EventName { get; set; }
public virtual decimal Amount { get; set; }
public virtual int Units { get; set; }
public virtual string PaymentMethodId { get; set; }
}
public partial class SalesDowBucket
{
public virtual int Dow { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
public virtual int Tickets { get; set; }
}
public partial class SalesHourBucket
{
public virtual int Hour { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
public virtual int Tickets { get; set; }
}
public partial class SalesTrendBucket
{
public virtual DateTime Bucket { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Tickets { get; set; }
}
}
C# 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
}