Difference between revisions of "Movie"

From Gvp-public
Jump to navigation Jump to search
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{Information|Message=You are accessing the latest version of this data type, according to <span style="font-weight:bold">/service3.0 (3.2)</span> specification. To access older versions of this object, access [[Movie_3.0]]}}
 +
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
 
|Description=Movie is an object that represent a Movie registered in the platform to get all data information about a movie. Similar to [[SimpleMovie]] object, this method has user data information as CanWatch and Access rights.
 
|Description=Movie is an object that represent a Movie registered in the platform to get all data information about a movie. Similar to [[SimpleMovie]] object, this method has user data information as CanWatch and Access rights.
Line 97: Line 99:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Images
 
−
{{!}} Array of [[Image]]
 
−
{{!}} Array of [[Image]] object registered in the platform.
 
−
{{!}}- valign="top"
 
  
 
! ImdbRating
 
! ImdbRating
 
{{!}} double
 
{{!}} double
 
{{!}}  
 
{{!}}  
 +
{{!}}- valign="top"
 +
 +
! IsComingSoon
 +
{{!}} bool
 +
{{!}} '''GVP 3.0'''. Set if the content is coming soon or not. In case IsComingSoon is TRUE, the content doesn't have main media, only trailers media available for user.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 114: Line 117:
 
! LicenseEnd
 
! LicenseEnd
 
{{!}} long
 
{{!}} long
−
{{!}}  
+
{{!}} The current movie availability window end for the instance being requested
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! LicenseStart
 
! LicenseStart
 
{{!}} long
 
{{!}} long
−
{{!}}  
+
{{!}} The current movie availability window start for the instance being requested
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 134: Line 137:
 
! OriginalTitle
 
! OriginalTitle
 
{{!}} String
 
{{!}} String
−
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. Original title of the movie
+
{{!}} '''GVP 3.0'''. Original title of the movie
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 169: Line 172:
 
! SeasonNumber
 
! SeasonNumber
 
{{!}} int
 
{{!}} int
−
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. If a movie is a part of Season (an Episode), it contains the season number.
+
{{!}} '''GVP 3.0'''. If a movie is a part of Season (an Episode), it contains the season number.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 179: Line 182:
 
! SeriesName
 
! SeriesName
 
{{!}} String
 
{{!}} String
−
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. If a movie is a part of Series ('''such as an Episode or a Season'''), it contains the series name
+
{{!}} '''GVP 3.0'''. If a movie is a part of Series ('''such as an Episode or a Season'''), it contains the series name
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 220: Line 223:
 
{{!}} [[Media]]
 
{{!}} [[Media]]
 
{{!}}  
 
{{!}}  
 +
{{!}}- valign="top"
 +
 +
! TransparentProvider
 +
{{!}} [[TransparentProvider]]
 +
{{!}} bgcolor="green" {{!}} '''NEW in 4.0''' Provider (None, HBO, Fox...) of the TransparentCatchup content
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 238: Line 246:
  
 
! PlaybackInfos
 
! PlaybackInfos
−
{{!}} int
+
{{!}} Array of [[PlaybackInfo]] object
 
{{!}} Playback info for specific device types requested in deviceTypes filter.
 
{{!}} Playback info for specific device types requested in deviceTypes filter.
 +
{{!}}- valign="top"
 +
 +
! Subscriptions
 +
{{!}} Array of int
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 3.2!''' List of Subscription IDs where this Movie is available in (as commercial offer)
 +
{{!}}- valign="top"
 +
 +
! SeriesPid
 +
{{!}} String
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 8.2!''' To indicate which is the new LiveSeries (LSR) object or the VoDSeries (SER) object that the movie belongs
 +
{{!}}- valign="top"
 +
 +
! SeasonPid
 +
{{!}} String
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 8.2!''' To indicate which is the new LiveSeasons (LSE) object or the VoDSeasons (SEA) object that the movie belongs
 
{{!}}- valign="top"
 
{{!}}- valign="top"
 
{{!}}}
 
{{!}}}
−
 
  
 
|Example=
 
|Example=
Line 269: Line 291:
 
:        "Description" : "Bem vindo ao canal ...",
 
:        "Description" : "Bem vindo ao canal ...",
 
:        "ShortDescription": "Bem-vindo ao canal ...",
 
:        "ShortDescription": "Bem-vindo ao canal ...",
−
:        "Images": [
 
−
::          Array of [[Image]] object
 
−
:        ],
 
 
:        "ResizableImages": [
 
:        "ResizableImages": [
 
::          Array of [[Image]] object
 
::          Array of [[Image]] object
Line 279: Line 298:
 
::          Array of [[Media]]
 
::          Array of [[Media]]
 
:        ],
 
:        ],
 +
:        "TransparentProvider" : 0,
 
:        "Trailers" : [],
 
:        "Trailers" : [],
 
:        "Subtitles": [
 
:        "Subtitles": [
Line 301: Line 321:
 
:        "PlaybackAccess": 2,
 
:        "PlaybackAccess": 2,
 
:        "BestMediaToPlay": 55793,  
 
:        "BestMediaToPlay": 55793,  
 +
:        "IsComingSoon": false,
 
:        "IsDtp": false,
 
:        "IsDtp": false,
 
:        "Distributor": {
 
:        "Distributor": {
Line 310: Line 331:
 
:        }
 
:        }
 
:      "PlaybackInfos": [
 
:      "PlaybackInfos": [
−
::        {"DeviceType": 501, "AFTDQualities": 2, "IsPlayback": true},
+
::        Array of [[PlaybackInfo]] object
−
::        {"DeviceType": 601, "AFTDQualities": 1, "IsPlayback": false}
+
:         ],
−
:        ]
+
:        "Subscriptions": [121,423,655,704]
 +
:        "SeriesPid": LSRXXXX,
 +
:        "SeasonPid": LSEXXXX,
 
}
 
}
  
Line 342: Line 365:
 
{{!}}  Alberto Los Santos
 
{{!}}  Alberto Los Santos
 
{{!}}- valign="top"
 
{{!}}- valign="top"
 +
 +
! 3.0
 +
{{!}} Added IsComingSoon
 +
{{!}}  Ricardo Calvo
 +
{{!}}- valign="top"
 +
 +
! 3.2
 +
{{!}} Added:
 +
* Subscriptions
 +
Removed:
 +
* Images array
 +
{{!}}  Francisco Milagro
 +
{{!}}- valign="top"
 +
 +
! 4.0
 +
{{!}} Added field TransparentProvider
 +
{{!}} Jose A. Jiménez
 +
{{!}}- valign="top"
 +
 
{{!}}}
 
{{!}}}
  

Latest revision as of 13:50, 29 June 2020

Infobox info icon.svg.png

You are accessing the latest version of this data type, according to /service3.0 (3.2) specification. To access older versions of this object, access Movie_3.0


Movie is an object that represent a Movie registered in the platform to get all data information about a movie. Similar to SimpleMovie object, this method has user data information as CanWatch and Access rights.

Members

Field Data Type Description
AFTDQualities int
AgeRating InstanceAgeRating An object that contains all information about the ageRatings of the movie returned.
AssetType AssetType
AvailableForThisDevice bool Set if the movie is available for the device from the currently request (device logged for the request).
AvailableForThisDeviceInHD bool Set if the movie is available for the device in HD mode in currently request (device logged for the request).
AvailableForThisDeviceInSD bool Set if the movie is available for the device in SD mode in currently request (device logged for the request).
BestMediaToPlay int
CanAcquire int
CanWatch AccessReason
ChildrenCount int
CommercializationType CommercializationType An object represented by a number type (enumeration) that represent a type as the product is commercialised.
Description String
Distributor Distributor An object represented by a number type (enumeration) that represent a type as the product is distributed.
Duration int A number that represent the time duration of the movie expressed in seconds.
Genres Genre An object that contains an array of Genre object assigned to movie.
HaveVoDAccess bool
ID int A unique identifier for the movie
ImdbRating double
IsComingSoon bool GVP 3.0. Set if the content is coming soon or not. In case IsComingSoon is TRUE, the content doesn't have main media, only trailers media available for user.
IsDtp bool Set if the movie is available to be downloaded and play offline.
LicenseEnd long The current movie availability window end for the instance being requested
LicenseStart long The current movie availability window start for the instance being requested
Medias Media Array of Media object that contains a series of information about the movie's media.
OrderEpisode int Set the episode order that wants to be returned the content.
OriginalTitle String GVP 3.0. Original title of the movie
PlaybackAccess PlaybackRight A number that indicate a kind of right the user has rights access.
Producer Producer An object that represent the producer of the movie.
ReleaseDate long
RequiresPin bool Set if the PIN is necessary to access the movie and playback.
ResizableImages Array of Image
SeasonId int If a movie is a part of Season (an Episode), the season id gonna come here to indicate which season's parent.
SeasonNumber int GVP 3.0. If a movie is a part of Season (an Episode), it contains the season number.
SeriesId int If a movie is a part of Series (such as an episode or a Season), the series id gonna come here to indicate which season's parent.
SeriesName String GVP 3.0. If a movie is a part of Series (such as an Episode or a Season), it contains the series name
ShortDescription String A short description about the movie.
Source int
Staff Array of MovieStaff object
Stars double The average of rating stars all user classify a movie.
Subtitles Subtitle Array of Subtitle object.
Tags ProductTag
Title String A string that represent a name of the movie.
Trailers Media
TransparentProvider TransparentProvider NEW in 4.0 Provider (None, HBO, Fox...) of the TransparentCatchup content
Type MovieType Enumerate that represents a kind of movie is the content. It can be
Views int Number of view the content has been visualised.
Year int A year of the movie.
PlaybackInfos Array of PlaybackInfo object Playback info for specific device types requested in deviceTypes filter.
Subscriptions Array of int NEW IN 3.2! List of Subscription IDs where this Movie is available in (as commercial offer)
SeriesPid String NEW IN 8.2! To indicate which is the new LiveSeries (LSR) object or the VoDSeries (SER) object that the movie belongs
SeasonPid String NEW IN 8.2! To indicate which is the new LiveSeasons (LSE) object or the VoDSeasons (SEA) object that the movie belongs


Example

{

"ID": 13939,
"SeriesId": 0,
"SeriesName": "",
"SeasonId": 0,
"SeasonNumber": 0,
"Type": 1,
"Title": "_Bem-vindo ao canal Adulto",
"OriginalTitle": "Welcome to Adult channel",
"Duration": 60,
"ReleaseDate": 1325372400,
"Year": 0,
"Genres": [
Array of Genre objects
],
"ImdbRating": 0,
"AgeRating": {
InstanceAgeRating object
},
"Stars": 2.81818181818182,
"Views": 235,
"Description" : "Bem vindo ao canal ...",
"ShortDescription": "Bem-vindo ao canal ...",
"ResizableImages": [
Array of Image object
],
"Staff" : [],
"Medias": [
Array of Media
],
"TransparentProvider" : 0,
"Trailers" : [],
"Subtitles": [
Array of Subtitle object
],
"RequiresPin": true,
"Tags" : [],
"CanWatch" : {
CanWatch object
},
"CanAquire": false,
"HaveVoDAccess": false,
"ChildrenCount": 0,
"AvailableForThisDevice": true,
"AFTDQualities": 2,
"AvailableForThisDeviceInHD": true,
"AvailableForThisDeviceInSD": true,
"OrderEpisode": 0,
"LicenseStart": 1372636800,
"LicenseEnd": 1419984000,
"Source": 79,
"PlaybackAccess": 2,
"BestMediaToPlay": 55793,
"IsComingSoon": false,
"IsDtp": false,
"Distributor": {
Distributor object
},
"CommercializationType": 4,
"Producer": {
Producer
}
"PlaybackInfos": [
Array of PlaybackInfo object
],
"Subscriptions": [121,423,655,704]
"SeriesPid": LSRXXXX,
"SeasonPid": LSEXXXX,

}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation Harley Cabral
3.0 Added original title of the movie
3.0 Added PlaybackInfos Alberto Los Santos
3.0 Added IsComingSoon Ricardo Calvo
3.2 Added:
  • Subscriptions

Removed:

  • Images array
 Francisco Milagro
4.0 Added field TransparentProvider Jose A. Jiménez


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=Movie&oldid=3416"