diff options
Diffstat (limited to 'MediaBrowser.Api/Reports/ReportRequests.cs')
| -rw-r--r-- | MediaBrowser.Api/Reports/ReportRequests.cs | 156 |
1 files changed, 146 insertions, 10 deletions
diff --git a/MediaBrowser.Api/Reports/ReportRequests.cs b/MediaBrowser.Api/Reports/ReportRequests.cs index 7fe0bfba1..1a7b3284b 100644 --- a/MediaBrowser.Api/Reports/ReportRequests.cs +++ b/MediaBrowser.Api/Reports/ReportRequests.cs @@ -7,8 +7,80 @@ using System.Linq; namespace MediaBrowser.Api.Reports { - public class BaseReportRequest : BaseItemsRequest - { + public interface IReportsDownload : IReportsQuery + { + /// <summary> Gets or sets the minimum date. </summary> + /// <value> The minimum date. </value> + string MinDate { get; set; } + } + + /// <summary> Interface for reports query. </summary> + public interface IReportsQuery : IReportsHeader + { + /// <summary> + /// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.GetActivityLogs has + /// query limit. </summary> + /// <value> + /// true if this MediaBrowser.Api.Reports.GetActivityLogs has query limit, false if not. </value> + bool HasQueryLimit { get; set; } + /// <summary> Gets or sets who group this MediaBrowser.Api.Reports.GetActivityLogs. </summary> + /// <value> Describes who group this MediaBrowser.Api.Reports.GetActivityLogs. </value> + string GroupBy { get; set; } + + /// <summary> + /// Skips over a given number of items within the results. Use for paging. + /// </summary> + /// <value>The start index.</value> + int? StartIndex { get; set; } + /// <summary> + /// The maximum number of items to return + /// </summary> + /// <value>The limit.</value> + int? Limit { get; set; } + + } + public interface IReportsHeader + { + /// <summary> Gets or sets the report view. </summary> + /// <value> The report view. </value> + string ReportView { get; set; } + + /// <summary> Gets or sets the report columns. </summary> + /// <value> The report columns. </value> + string ReportColumns { get; set; } + + /// <summary> Gets or sets a list of types of the include items. </summary> + /// <value> A list of types of the include items. </value> + string IncludeItemTypes { get; set; } + + } + + public class BaseReportRequest : BaseItemsRequest, IReportsQuery + { + /// <summary> Gets or sets the report view. </summary> + /// <value> The report view. </value> + [ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportView { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.BaseReportRequest has + /// query limit. </summary> + /// <value> + /// true if this MediaBrowser.Api.Reports.BaseReportRequest has query limit, false if not. </value> + [ApiMember(Name = "HasQueryLimit", Description = "Optional. If specified, results will include all records.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")] + public bool HasQueryLimit { get; set; } + + /// <summary> + /// Gets or sets who group this MediaBrowser.Api.Reports.BaseReportRequest. </summary> + /// <value> Describes who group this MediaBrowser.Api.Reports.BaseReportRequest. </value> + [ApiMember(Name = "GroupBy", Description = "Optional. If specified, results will include grouped records.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string GroupBy { get; set; } + + /// <summary> Gets or sets the report columns. </summary> + /// <value> The report columns. </value> + [ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportColumns { get; set; } + /// <summary> /// Gets or sets the user id. /// </summary> @@ -63,11 +135,6 @@ namespace MediaBrowser.Api.Reports [ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] public string Ids { get; set; } - public bool HasQueryLimit { get; set; } - public string GroupBy { get; set; } - - public string ReportColumns { get; set; } - /// <summary> /// Gets or sets the video types. /// </summary> @@ -261,8 +328,22 @@ namespace MediaBrowser.Api.Reports } [Route("/Reports/Headers", "GET", Summary = "Gets reports headers based on library items")] - public class GetReportHeaders : BaseReportRequest, IReturn<List<ReportHeader>> - { + public class GetReportHeaders : IReturn<List<ReportHeader>>, IReportsHeader + { + /// <summary> Gets or sets the report view. </summary> + /// <value> The report view. </value> + [ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportView { get; set; } + + /// <summary> Gets or sets a list of types of the include items. </summary> + /// <value> A list of types of the include items. </value> + [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] + public string IncludeItemTypes { get; set; } + + /// <summary> Gets or sets the report columns. </summary> + /// <value> The report columns. </value> + [ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportColumns { get; set; } } [Route("/Reports/Statistics", "GET", Summary = "Gets reports statistics based on library items")] @@ -273,7 +354,7 @@ namespace MediaBrowser.Api.Reports } [Route("/Reports/Items/Download", "GET", Summary = "Downloads report")] - public class GetReportDownload : BaseReportRequest + public class GetReportDownload : BaseReportRequest, IReportsDownload { public GetReportDownload() { @@ -281,6 +362,61 @@ namespace MediaBrowser.Api.Reports } public ReportExportType ExportType { get; set; } + + /// <summary> Gets or sets the minimum date. </summary> + /// <value> The minimum date. </value> + [ApiMember(Name = "MinDate", Description = "Optional. The minimum date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")] + public string MinDate { get; set; } + } + + [Route("/Reports/Activities", "GET", Summary = "Gets activities entries")] + public class GetActivityLogs : IReturn<ReportResult>, IReportsQuery, IReportsDownload + { + /// <summary> Gets or sets the report view. </summary> + /// <value> The report view. </value> + [ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportView { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.GetActivityLogs has + /// query limit. </summary> + /// <value> + /// true if this MediaBrowser.Api.Reports.GetActivityLogs has query limit, false if not. </value> + [ApiMember(Name = "HasQueryLimit", Description = "Optional. If specified, results will include all records.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")] + public bool HasQueryLimit { get; set; } + + /// <summary> Gets or sets who group this MediaBrowser.Api.Reports.GetActivityLogs. </summary> + /// <value> Describes who group this MediaBrowser.Api.Reports.GetActivityLogs. </value> + [ApiMember(Name = "GroupBy", Description = "Optional. If specified, results will include grouped records.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string GroupBy { get; set; } + + /// <summary> Gets or sets the report columns. </summary> + /// <value> The report columns. </value> + [ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ReportColumns { get; set; } + + /// <summary> + /// Skips over a given number of items within the results. Use for paging. + /// </summary> + /// <value>The start index.</value> + [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] + public int? StartIndex { get; set; } + + /// <summary> + /// The maximum number of items to return + /// </summary> + /// <value>The limit.</value> + [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")] + public int? Limit { get; set; } + + /// <summary> Gets or sets the minimum date. </summary> + /// <value> The minimum date. </value> + [ApiMember(Name = "MinDate", Description = "Optional. The minimum date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")] + public string MinDate { get; set; } + + [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] + public string IncludeItemTypes { get; set; } + } } |