GET api/MediaObjects/GetTopRatedMedia?top={top}&startDate={startDate}&endDate={endDate}&siteName={siteName}

Gets top rated Media objects. Note: Ratings ara cached and refereshed once a day.

Request Information

Parameters

NameDescriptionAdditional information
top
Number of top Media objects to consider.

Define this parameter in the request URI.

startDate
Start date of a time period for which rating calculations are considered. Optional.

Define this parameter in the request URI.

endDate
End date of a time pedriod for which rating calculations are considered. Optional.

Define this parameter in the request URI.

siteName
Site name for which to get top rated Media objects. Optional.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  null,
  {
    "MediaID": "a4161980-9be8-4c1a-be5e-1956d023bb86",
    "FilePath": "sample string 2",
    "ThumbnailFilePath": "sample string 3",
    "FileType": "sample string 4",
    "Type": "Other",
    "Title": "sample string 5",
    "Description": "sample string 6",
    "CreatedTime": "2024-03-28T04:25:44.9402857-07:00",
    "UpdatedTime": "2024-03-28T04:25:44.9402857-07:00",
    "MediaCategoryID": "b030192d-ffe5-4f43-8b12-3168fd38f356",
    "IsPublic": true,
    "IsHidden": true,
    "IsFileLocked": true,
    "Views": 1,
    "Width": 1,
    "Height": 1,
    "SiteName": "sample string 9",
    "Duration": 1,
    "Order": 1
  },
  {
    "MediaID": "a4161980-9be8-4c1a-be5e-1956d023bb86",
    "FilePath": "sample string 2",
    "ThumbnailFilePath": "sample string 3",
    "FileType": "sample string 4",
    "Type": "Other",
    "Title": "sample string 5",
    "Description": "sample string 6",
    "CreatedTime": "2024-03-28T04:25:44.9402857-07:00",
    "UpdatedTime": "2024-03-28T04:25:44.9402857-07:00",
    "MediaCategoryID": "b030192d-ffe5-4f43-8b12-3168fd38f356",
    "IsPublic": true,
    "IsHidden": true,
    "IsFileLocked": true,
    "Views": 1,
    "Width": 1,
    "Height": 1,
    "SiteName": "sample string 9",
    "Duration": 1,
    "Order": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediaLibrarianCore">
  <Media i:nil="true" />
  <Media>
    <CreatedTime>2024-03-28T04:25:44.9402857-07:00</CreatedTime>
    <Description>sample string 6</Description>
    <Duration>1</Duration>
    <FilePath>sample string 2</FilePath>
    <FileType>sample string 4</FileType>
    <Height>1</Height>
    <IsFileLocked>true</IsFileLocked>
    <IsHidden>true</IsHidden>
    <IsPublic>true</IsPublic>
    <MediaCategoryID>b030192d-ffe5-4f43-8b12-3168fd38f356</MediaCategoryID>
    <MediaID>a4161980-9be8-4c1a-be5e-1956d023bb86</MediaID>
    <Order>1</Order>
    <SiteName>sample string 9</SiteName>
    <ThumbnailFilePath>sample string 3</ThumbnailFilePath>
    <Title>sample string 5</Title>
    <Type>Other</Type>
    <UpdatedTime>2024-03-28T04:25:44.9402857-07:00</UpdatedTime>
    <Views>1</Views>
    <Width>1</Width>
  </Media>
  <Media>
    <CreatedTime>2024-03-28T04:25:44.9402857-07:00</CreatedTime>
    <Description>sample string 6</Description>
    <Duration>1</Duration>
    <FilePath>sample string 2</FilePath>
    <FileType>sample string 4</FileType>
    <Height>1</Height>
    <IsFileLocked>true</IsFileLocked>
    <IsHidden>true</IsHidden>
    <IsPublic>true</IsPublic>
    <MediaCategoryID>b030192d-ffe5-4f43-8b12-3168fd38f356</MediaCategoryID>
    <MediaID>a4161980-9be8-4c1a-be5e-1956d023bb86</MediaID>
    <Order>1</Order>
    <SiteName>sample string 9</SiteName>
    <ThumbnailFilePath>sample string 3</ThumbnailFilePath>
    <Title>sample string 5</Title>
    <Type>Other</Type>
    <UpdatedTime>2024-03-28T04:25:44.9402857-07:00</UpdatedTime>
    <Views>1</Views>
    <Width>1</Width>
  </Media>
</ArrayOfMedia>