Difference between revisions of "Tag"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_DataType_Spec |Description=Tag is a par of [http://wikis.tid.es/gvp-public/index.php/TagType|TagType] and value used to describe properties associated to contents. |Mem...")
 
Line 1: Line 1:
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
|Description=Tag is a par of [http://wikis.tid.es/gvp-public/index.php/TagType|TagType] and value used to describe properties associated to contents.
+
|Description=Tag is a par of [[TagType]] and value used to describe properties associated to contents.
  
 
|Members=
 
|Members=
Line 12: Line 12:
  
  
! AgeRating
+
! TagType
{{!}} [[InstanceAgeRating]]
+
{{!}} [[TagType]]
{{!}} An object that contains all information about the ageRatings of the movie returned.
+
{{!}} Tag type
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
! AvailableForThisDevice
+
! Value
 
{{!}} bool
 
{{!}} bool
{{!}} Set if the movie is available for the device from the currently request (device logged for the request).
+
{{!}} Value associated to tag
{{!}}- 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"
 
 
 
! ChildrenCount
 
{{!}} int
 
{{!}}
 
{{!}}- valign="top"
 
 
 
! CommercializationType
 
{{!}} [[CommercializationType]]
 
{{!}} An enumeration represented by a number that represent a type as the product is commercialised.
 
{{!}}- valign="top"
 
 
 
! Distributor
 
{{!}} [[Distributor]]
 
{{!}} An object that contains information about the distributor.
 
{{!}}- 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"
 
 
 
! ID
 
{{!}} int
 
{{!}} A unique identifier for the movie
 
{{!}}- valign="top"
 
 
 
! Images
 
{{!}} Array of [[Image]]
 
{{!}} Array of [[Image]] object registered in the platform.
 
{{!}}- valign="top"
 
 
 
! IsDtp
 
{{!}} bool
 
{{!}} Set if the movie is available to be downloaded and play offline.
 
{{!}}- 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"
 
 
 
! 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"
 
 
 
! 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 (an 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"
 
 
 
! Stars
 
{{!}} double
 
{{!}} The average of rating stars all user classify a movie.
 
{{!}}- valign="top"
 
 
 
! Subtitles
 
{{!}} [[Subtitle]]
 
{{!}} Array of [[Subtitle]] object.
 
{{!}}- valign="top"
 
 
 
! Title
 
{{!}} String
 
{{!}} A string that represent a name of the movie.
 
{{!}}- 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"
 
{{!}}- valign="top"
  
Line 163: Line 28:
  
 
{
 
{
:        "ID": 13939,
+
:        "TagType": 1,
:        "SeriesId": 0,
+
:        "Value": 4
:        "SeriesName": "",
 
:        "SeasonId": 0,
 
:        "SeasonNumber": 0,
 
:        "Type": 1,
 
:        "Title": "_Bem-vindo ao canal Adulto",
 
:        "Duration": 60,
 
:        "Year": 0,
 
:        "AgeRating": {
 
::          [[InstanceAgeRating]] object
 
:        },
 
:        "Subtitles": [
 
::          Array of [[Subtitle]] object
 
:        ],
 
:        "Genres": [
 
::          Array of [[Genre]] objects
 
:        ],
 
:        "Stars": 2.81818181818182,
 
:        "Views": 235,
 
:        "ShortDescription": "Bem-vindo ao canal ...",
 
:        "Images": [
 
::          Array of [[Image]] object
 
:        ],
 
:        "ResizableImages": [
 
::          Array of [[Image]] object
 
:        ],
 
:        "RequiresPin": true,
 
:        "ChildrenCount": 0,
 
:        "Medias": [
 
::          Array of [[Media]]
 
:        ],
 
:        "AvailableForThisDevice": true,
 
:        "AvailableForThisDeviceInHD": true,
 
:        "AvailableForThisDeviceInSD": true,
 
:        "OrderEpisode": 0,
 
:        "PlaybackAccess": 2,
 
:        "IsDtp": false,
 
:        "Distributor": {
 
::            [[Distributor]] object
 
:        },
 
:        "CommercializationType": 4,
 
:        "Producer": {
 
::          [[Producer]]
 
:        }
 
 
}
 
}
  
Line 223: Line 45:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
! 1.0
+
! 3.0
 
{{!}} Initial data type implementation
 
{{!}} Initial data type implementation
 
{{!}} Harley Cabral
 
{{!}} Harley Cabral

Revision as of 15:33, 19 February 2015

Tag is a par of TagType and value used to describe properties associated to contents.

Members

Field Data Type Description
TagType TagType Tag type
Value bool Value associated to tag


Example

{

"TagType": 1,
"Value": 4

}


Known issues

None


Version history

API Version Number Change description Changes author
3.0 Initial data type implementation Harley Cabral


See also