Id02256: Created page with "{{Information|Message=You are accessing the 3.0 version of this data type, according to /service (3.0) specification. To access newest ve..."

2015-08-14T16:55:02Z

Created page with "{{Information|Message=You are accessing the 3.0 version of this data type, according to <span style="font-weight:bold">/service (3.0)</span> specification. To access newest ve..."

New page

{{Information|Message=You are accessing the 3.0 version of this data type, according to <span style="font-weight:bold">/service (3.0)</span> specification. To access newest versions of this object, access [[Movie]]}}

{{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.

|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"

{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"

! AFTDQualities
{{!}} int
{{!}}
{{!}}- valign="top"

! AgeRating
{{!}} [[InstanceAgeRating]]
{{!}} An object that contains all information about the ageRatings of the movie returned.
{{!}}- valign="top"

! AssetType
{{!}} [[AssetType]]
{{!}}
{{!}}- valign="top"

! AvailableForThisDevice
{{!}} bool
{{!}} Set if the movie is available for the device from the currently request (device logged for the request).
{{!}}- valign="top"

! AvailableForThisDeviceInHD
{{!}} bool
{{!}} Set if the movie is available for the device in HD mode in currently request (device logged for the request).
{{!}}- valign="top"

! AvailableForThisDeviceInSD
{{!}} bool
{{!}} Set if the movie is available for the device in SD mode in currently request (device logged for the request).
{{!}}- valign="top"

! BestMediaToPlay
{{!}} int
{{!}}
{{!}}- valign="top"

! CanAcquire
{{!}} int
{{!}}
{{!}}- valign="top"

! CanWatch
{{!}} [[AccessReason]]
{{!}}
{{!}}- valign="top"

! ChildrenCount
{{!}} int
{{!}}
{{!}}- valign="top"

! CommercializationType
{{!}} [[CommercializationType]]
{{!}} An object represented by a number type (enumeration) that represent a type as the product is commercialised.
{{!}}- valign="top"

! Description
{{!}} String
{{!}}
{{!}}- valign="top"

! Distributor
{{!}} [[Distributor]]
{{!}} An object represented by a number type (enumeration) that represent a type as the product is distributed.
{{!}}- valign="top"

! Duration
{{!}} int
{{!}} A number that represent the time duration of the movie expressed in seconds.
{{!}}- valign="top"

! Genres
{{!}} [[Genre]]
{{!}} An object that contains an array of [[Genre]] object assigned to movie.
{{!}}- valign="top"

! HaveVoDAccess
{{!}} bool
{{!}}
{{!}}- valign="top"

! ID
{{!}} int
{{!}} A unique identifier for the movie
{{!}}- valign="top"

! Images
{{!}} Array of [[Image]]
{{!}} Array of [[Image]] object registered in the platform.
{{!}}- valign="top"

! ImdbRating
{{!}} double
{{!}}
{{!}}- valign="top"

! IsComingSoon
{{!}} bool
{{!}} bgcolor="#00FF00" {{!}} '''NEW FOR 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"

! IsDtp
{{!}} bool
{{!}} Set if the movie is available to be downloaded and play offline.
{{!}}- valign="top"

! LicenseEnd
{{!}} long
{{!}} The current movie availability window end for the instance being requested
{{!}}- valign="top"

! LicenseStart
{{!}} long
{{!}} The current movie availability window start for the instance being requested
{{!}}- valign="top"

! Medias
{{!}} [[Media]]
{{!}} Array of [[Media]] object that contains a series of information about the movie's media.
{{!}}- valign="top"

! OrderEpisode
{{!}} int
{{!}} Set the episode order that wants to be returned the content.
{{!}}- valign="top"

! OriginalTitle
{{!}} String
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. Original title of the movie
{{!}}- valign="top"

! PlaybackAccess
{{!}} [[PlaybackRight]]
{{!}} A number that indicate a kind of right the user has rights access.
{{!}}- valign="top"

! Producer
{{!}} [[Producer]]
{{!}} An object that represent the producer of the movie.
{{!}}- valign="top"

! ReleaseDate
{{!}} long
{{!}}
{{!}}- valign="top"

! RequiresPin
{{!}} bool
{{!}} Set if the PIN is necessary to access the movie and playback.
{{!}}- valign="top"

! ResizableImages
{{!}} Array of [[Image]]
{{!}}
{{!}}- valign="top"

! SeasonId
{{!}} int
{{!}} If a movie is a part of Season (an Episode), the season id gonna come here to indicate which season's parent.
{{!}}- valign="top"

! SeasonNumber
{{!}} int
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. If a movie is a part of Season (an Episode), it contains the season number.
{{!}}- valign="top"

! 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.
{{!}}- valign="top"

! SeriesName
{{!}} 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
{{!}}- valign="top"

! ShortDescription
{{!}} String
{{!}} A short description about the movie.
{{!}}- valign="top"

! Source
{{!}} int
{{!}}
{{!}}- valign="top"

! Staff
{{!}} Array of [[MovieStaff]] object
{{!}}
{{!}}- valign="top"

! Stars
{{!}} double
{{!}} The average of rating stars all user classify a movie.
{{!}}- valign="top"

! Subtitles
{{!}} [[Subtitle]]
{{!}} Array of [[Subtitle]] object.
{{!}}- valign="top"

! Tags
{{!}} [[ProductTag]]
{{!}}
{{!}}- valign="top"

! Title
{{!}} String
{{!}} A string that represent a name of the movie.
{{!}}- valign="top"

! Trailers
{{!}} [[Media]]
{{!}}
{{!}}- valign="top"

! Type
{{!}} [[MovieType]]
{{!}} Enumerate that represents a kind of movie is the content. It can be
{{!}}- valign="top"

! Views
{{!}} int
{{!}} Number of view the content has been visualised.
{{!}}- valign="top"

! Year
{{!}} int
{{!}} A year of the movie.
{{!}}- valign="top"

! PlaybackInfos
{{!}} Array of [[PlaybackInfo]] object
{{!}} Playback info for specific device types requested in deviceTypes filter.
{{!}}- valign="top"
{{!}}}

|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 ...",
: "Images": [
:: Array of [[Image]] object
: ],
: "ResizableImages": [
:: Array of [[Image]] object
: ],
: "Staff" : [],
: "Medias": [
:: Array of [[Media]]
: ],
: "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
: ]
}

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"

{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"

! 1.0
{{!}} Initial data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"

! 3.0
{{!}} Added original title of the movie
{{!}}
{{!}}- valign="top"

! 3.0
{{!}} Added PlaybackInfos
{{!}} Alberto Los Santos
{{!}}- valign="top"

! 3.0
{{!}} Added IsComingSoon
{{!}} Ricardo Calvo
{{!}}- valign="top"

{{!}}}

|SeeAlso=

}}

Movie 3.0 - Revision history

Id02256: Created page with "{{Information|Message=You are accessing the 3.0 version of this data type, according to /service (3.0) specification. To access newest ve..."