| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/overview |
|---|
namespace TicketUserServices.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SalesKpis() =
member val GrossNet:Decimal = new Decimal() with get,set
member val Refunded:Decimal = new Decimal() with get,set
member val TicketsAllReal:Int32 = new Int32() with get,set
member val TicketsPaid:Int32 = new Int32() with get,set
member val Orders:Int32 = new Int32() with get,set
member val Aov: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 SalesDeltas() =
member val GrossNet:KpiDelta = null with get,set
member val Refunded:KpiDelta = null with get,set
member val TicketsAllReal:KpiDelta = null with get,set
member val TicketsPaid:KpiDelta = null with get,set
member val Orders:KpiDelta = null with get,set
member val Aov: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 SalesTopEvent() =
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 GrossNet:Decimal = new Decimal() with get,set
member val PaidTickets:Int32 = new Int32() with get,set
member val RealTickets:Int32 = new Int32() with get,set
member val Orders:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesRecentOrder() =
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 TicketCount:Int32 = new Int32() with get,set
member val BuyerName:String = null 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 SalesProduct() =
member val TicketName:String = null with get,set
member val Tickets:Int32 = new Int32() with get,set
member val Revenue:Decimal = new Decimal() with get,set
member val Orders:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type SalesOverviewResult() =
member val Current:SalesKpis = null with get,set
member val Previous:SalesKpis = null with get,set
member val Delta:SalesDeltas = 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 TopEvents:ResizeArray<SalesTopEvent> = new ResizeArray<SalesTopEvent>() with get,set
member val RecentOrders:ResizeArray<SalesRecentOrder> = new ResizeArray<SalesRecentOrder>() 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 TopProducts:ResizeArray<SalesProduct> = new ResizeArray<SalesProduct>() with get,set
member val HasAnyDataEver:Boolean = new Boolean() with get,set
member val Owners:ResizeArray<Int32> = new ResizeArray<Int32>() 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 SalesOverviewRequest() =
member val EventOwnerId:Int32 = new Int32() with get,set
member val AdditionalOwnerIds:Int32[] = [||] with get,set
member val EventId: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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>