diff options
| author | Luke <luke.pulverenti@gmail.com> | 2017-09-20 13:22:39 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-20 13:22:39 -0400 |
| commit | eb2a1330045d802bfe0366df7105c220a36f111f (patch) | |
| tree | 2c1638c424ee9c0837c5de6d6e08a2398da69cdb /MediaBrowser.Api/Reports/ReportRequests.cs | |
| parent | ec426d5c92875639ceac64477ce10fab3e639335 (diff) | |
| parent | a015e1208885bc6a8788db683c4fe47e93dc26b7 (diff) | |
Merge pull request #2897 from MediaBrowser/beta
Beta
Diffstat (limited to 'MediaBrowser.Api/Reports/ReportRequests.cs')
| -rw-r--r-- | MediaBrowser.Api/Reports/ReportRequests.cs | 194 |
1 files changed, 0 insertions, 194 deletions
diff --git a/MediaBrowser.Api/Reports/ReportRequests.cs b/MediaBrowser.Api/Reports/ReportRequests.cs deleted file mode 100644 index 362795658..000000000 --- a/MediaBrowser.Api/Reports/ReportRequests.cs +++ /dev/null @@ -1,194 +0,0 @@ -using MediaBrowser.Api.UserLibrary; -using System.Collections.Generic; -using MediaBrowser.Model.Services; - -namespace MediaBrowser.Api.Reports -{ - 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; } - - /// <summary> Gets or sets a list of types of the displays. </summary> - /// <value> A list of types of the displays. </value> - string DisplayType { 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, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string ReportView { get; set; } - - /// <summary> Gets or sets the report view. </summary> - /// <value> The report view. </value> - [ApiMember(Name = "DisplayType", Description = "The report display type. Values (None, Screen, Export, ScreenExport)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string DisplayType { 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; } - - - } - - [Route("/Reports/Items", "GET", Summary = "Gets reports based on library items")] - public class GetItemReport : BaseReportRequest, IReturn<ReportResult> - { - - } - - [Route("/Reports/Headers", "GET", Summary = "Gets reports headers based on library items")] - 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, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string ReportView { get; set; } - - /// <summary> Gets or sets the report view. </summary> - /// <value> The report view. </value> - [ApiMember(Name = "DisplayType", Description = "The report display type. Values (None, Screen, Export, ScreenExport)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string DisplayType { 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/Items/Download", "GET", Summary = "Downloads report")] - public class GetReportDownload : BaseReportRequest, IReportsDownload - { - public GetReportDownload() - { - ExportType = ReportExportType.CSV; - } - - 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, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string ReportView { get; set; } - - /// <summary> Gets or sets the report view. </summary> - /// <value> The report view. </value> - [ApiMember(Name = "DisplayType", Description = "The report display type. Values (None, Screen, Export, ScreenExport)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")] - public string DisplayType { 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; } - } -} |
