Difference between revisions of "SortType"

From Gvp-public
Jump to navigation Jump to search
 
Line 19: Line 19:
 
! 0
 
! 0
 
{{!}} Default
 
{{!}} Default
{{!}} Not specified, will be ordered by default ordering (ID)  
+
{{!}} Not specified, will be ordered by default ordering (ID), but using the PID
{{!}} Order by Movie.ID
+
{{!}} Order by Movie.PID
{{!}} Order by LiveSchedule.ID
+
{{!}} Order by LiveSchedule.PID
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 35: Line 35:
 
{{!}} Order by Release date  
 
{{!}} Order by Release date  
 
{{!}} Order by Movie.RELEASE_DATE
 
{{!}} Order by Movie.RELEASE_DATE
{{!}} Order by Live Schedule related Live Program CREATION_YEAR
+
{{!}} Order by Live Schedule related Live Program RELEASE_DATE (start time)
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 56: Line 56:
 
{{!}} Order by most popular contents (most viewed) first. Not recommended to be used for LiveSchedule CatalogItemType  
 
{{!}} Order by most popular contents (most viewed) first. Not recommended to be used for LiveSchedule CatalogItemType  
 
{{!}} Order by Movie Views number  
 
{{!}} Order by Movie Views number  
{{!}} As Live Schedule don't have views, they will be ordered by default ordering (ID).
+
{{!}} As Live Schedule don't have views, they will have always VIEWS = 0
 
{{!}}- valign-"top"
 
{{!}}- valign-"top"
  
Line 70: Line 70:
 
{{!}} Order by movie user rating. Not recommended to be used for LiveSchedule CatalogItemType  
 
{{!}} Order by movie user rating. Not recommended to be used for LiveSchedule CatalogItemType  
 
{{!}} Order by Movie.Rating value  
 
{{!}} Order by Movie.Rating value  
{{!}} As Live Schedule don't have views, they will be ordered by default ordering (ID)
+
{{!}} As Live Schedule don't have views, they will have always VIEWS = 0
 
{{!}}- valign-"top"
 
{{!}}- valign-"top"
  
Line 76: Line 76:
 
! 20
 
! 20
 
{{!}} Episode Order
 
{{!}} Episode Order
{{!}} Order by Episode order. It doesn't apply to CatalogItem = Movie, Season, Serie, as it should be used only when retrieving children of a Season
+
{{!}} InvalidSortTypeException
{{!}} Order by Movie Episode ORDER field
+
{{!}} InvalidSortTypeException
{{!}} Order by Live Schedule EPG_EPISODE_NUMBER
+
{{!}} InvalidSortTypeException
 
{{!}}- valign-"top"
 
{{!}}- valign-"top"
  
 
! 21
 
! 21
 
{{!}} Season Order  
 
{{!}} Season Order  
{{!}} Order by Season order, ascending. It doesn't apply to CatalogItem = Movie, Episode, Serie, as it should be used only when retrieving children of a Serie
+
{{!}} InvalidSortTypeException
{{!}} Order by Season ORDER field and then by Episode Order field
+
{{!}} InvalidSortTypeException
{{!}} Order by Live Schedule EPG_SEASON_NUMBER
+
{{!}} InvalidSortTypeException
 
{{!}}- valign-"top"
 
{{!}}- valign-"top"
  

Latest revision as of 15:54, 4 October 2015

Lists of the new unified SortType.

This SortType is already implemented on SearchContent and GetChannelCatalogItems.

SortOrder has been implemented in a way to order ascending and descending for SortType.

Values

Value Name Details Movies/Series/Season LiveSchedule
0 Default Not specified, will be ordered by default ordering (ID), but using the PID Order by Movie.PID Order by LiveSchedule.PID
1 Title Order by title Order by Movie Metadata Title Order by Live Schedule related Live Program Title
2 Release Date Order by Release date Order by Movie.RELEASE_DATE Order by Live Schedule related Live Program RELEASE_DATE (start time)
3 Publication Date Order by the publication date of the content in the platform (Movie.STATUS_DATE) Order by Movie Status date Order by Live Schedule start date
4 Availability date Order by Availability Window date Order by Movie current active Availability Window start date Order by Live Schedule start date
5 Popularity Order by most popular contents (most viewed) first. Not recommended to be used for LiveSchedule CatalogItemType Order by Movie Views number As Live Schedule don't have views, they will have always VIEWS = 0
6 Editorial rating Order by editorial rating Order by Movie Promotional rating value Order by Live Schedule.Rating value
7 Most rated Order by movie user rating. Not recommended to be used for LiveSchedule CatalogItemType Order by Movie.Rating value As Live Schedule don't have views, they will have always VIEWS = 0
20 Episode Order InvalidSortTypeException InvalidSortTypeException InvalidSortTypeException
21 Season Order InvalidSortTypeException InvalidSortTypeException InvalidSortTypeException
22 Relevance (Search Only) Order by relevance in search result (best matching first) Order by relevance of search result Order by relevance of search result


Known issues

None


Version history

API Version Number Change description Changes author
3.2 Initial Implementation Ricardo Calvo


See also