ReportRequests.cs 1.5 KB

123456789101112131415161718192021222324252627282930313233
  1. using ServiceStack;
  2. namespace MediaBrowser.Api.Reports
  3. {
  4. public class BaseReportRequest : IReturn<ReportResult>
  5. {
  6. /// <summary>
  7. /// Specify this to localize the search to a specific item or folder. Omit to use the root.
  8. /// </summary>
  9. /// <value>The parent id.</value>
  10. [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")]
  11. public string ParentId { get; set; }
  12. /// <summary>
  13. /// Skips over a given number of items within the results. Use for paging.
  14. /// </summary>
  15. /// <value>The start index.</value>
  16. [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")]
  17. public int? StartIndex { get; set; }
  18. /// <summary>
  19. /// The maximum number of items to return
  20. /// </summary>
  21. /// <value>The limit.</value>
  22. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  23. public int? Limit { get; set; }
  24. }
  25. [Route("/Reports/Items", "GET", Summary = "Gets reports based on library items")]
  26. public class GetItemReport : BaseReportRequest
  27. {
  28. }
  29. }