| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Sales.Total |
| POST | /sales/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 SalesDeltas
{
public virtual KpiDelta GrossNet { get; set; }
public virtual KpiDelta Refunded { get; set; }
public virtual KpiDelta TicketsAllReal { get; set; }
public virtual KpiDelta TicketsPaid { get; set; }
public virtual KpiDelta Orders { get; set; }
public virtual KpiDelta Aov { 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 SalesKpis
{
public virtual decimal GrossNet { get; set; }
public virtual decimal Refunded { get; set; }
public virtual int TicketsAllReal { get; set; }
public virtual int TicketsPaid { get; set; }
public virtual int Orders { get; set; }
public virtual decimal Aov { get; set; }
}
public partial class SalesOverviewRequest
{
public SalesOverviewRequest()
{
AdditionalOwnerIds = new int[]{};
}
public virtual int EventOwnerId { get; set; }
public virtual int[] AdditionalOwnerIds { get; set; }
public virtual int? EventId { 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 SalesOverviewResult
{
public SalesOverviewResult()
{
Trend = new List<SalesTrendBucket>{};
PreviousTrend = new List<SalesTrendBucket>{};
TopEvents = new List<SalesTopEvent>{};
RecentOrders = new List<SalesRecentOrder>{};
ByHourOfDay = new List<SalesHourBucket>{};
ByDayOfWeek = new List<SalesDowBucket>{};
TopProducts = new List<SalesProduct>{};
Owners = new List<int>{};
}
public virtual SalesKpis Current { get; set; }
public virtual SalesKpis Previous { get; set; }
public virtual SalesDeltas Delta { get; set; }
public virtual List<SalesTrendBucket> Trend { get; set; }
public virtual List<SalesTrendBucket> PreviousTrend { get; set; }
public virtual List<SalesTopEvent> TopEvents { get; set; }
public virtual List<SalesRecentOrder> RecentOrders { get; set; }
public virtual List<SalesHourBucket> ByHourOfDay { get; set; }
public virtual List<SalesDowBucket> ByDayOfWeek { get; set; }
public virtual List<SalesProduct> TopProducts { get; set; }
public virtual bool HasAnyDataEver { get; set; }
public virtual List<int> Owners { 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 SalesProduct
{
public virtual string TicketName { get; set; }
public virtual int Tickets { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Orders { get; set; }
}
public partial class SalesRecentOrder
{
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 TicketCount { get; set; }
public virtual string BuyerName { get; set; }
}
public partial class SalesTopEvent
{
public virtual int EventId { get; set; }
public virtual string EventName { get; set; }
public virtual DateTime? EventDate { get; set; }
public virtual decimal GrossNet { get; set; }
public virtual int PaidTickets { get; set; }
public virtual int RealTickets { get; set; }
public virtual int Orders { get; set; }
}
public partial class SalesTrendBucket
{
public virtual DateTime Bucket { get; set; }
public virtual decimal Revenue { get; set; }
public virtual int Tickets { 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>