diff options
Diffstat (limited to 'MediaBrowser.Api/Reports/ReportRequests.cs')
| -rw-r--r-- | MediaBrowser.Api/Reports/ReportRequests.cs | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/MediaBrowser.Api/Reports/ReportRequests.cs b/MediaBrowser.Api/Reports/ReportRequests.cs new file mode 100644 index 000000000..8dea00381 --- /dev/null +++ b/MediaBrowser.Api/Reports/ReportRequests.cs @@ -0,0 +1,33 @@ +using ServiceStack; + +namespace MediaBrowser.Api.Reports +{ + public class BaseReportRequest : IReturn<ReportResult> + { + /// <summary> + /// Specify this to localize the search to a specific item or folder. Omit to use the root. + /// </summary> + /// <value>The parent id.</value> + [ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")] + public string ParentId { 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; } + } + + [Route("/Reports/Items", "GET", Summary = "Gets reports based on library items")] + public class GetItemReport : BaseReportRequest + { + } +} |
