Difference between revisions of "GetMediaUrlStb (Blender)"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Gets the multiple media URL for a movie (to be used on mediaroom) |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequir...")
 
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
−
Description=Gets the multiple media URL for a movie (to be used on mediaroom)
+
Description=
 +
Method provided by Blender as of TVOPEN 25.3
 +
 
 +
Get a list of [[ItemTags]] objects, based on Resumes Service.
 +
 
 +
The user must be logged to use this method.
  
 
|Parameters=
 
|Parameters=
−
 
 
{{Api_Parameter|
 
{{Api_Parameter|
 
ParamName=token
 
ParamName=token
 
|ParamType=String
 
|ParamType=String
 
|ParamRequired=required
 
|ParamRequired=required
−
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
+
|ParamDescription=A valid token for identifying the API session context. Anonymous access is not allowed.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=movieId
+
ParamName=offset
 
|ParamType=int
 
|ParamType=int
−
|ParamRequired=required
+
|ParamRequired=optional
−
|ParamDescription=The movie id that represent an movie registered and available on the instance.
+
|ParamDescription=Index of the initial result of the list, begins with 0
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=mediaId
+
ParamName=limit
 
|ParamType=int
 
|ParamType=int
−
|ParamRequired=required
+
|ParamRequired=optional
−
|ParamDescription=An id from media id that represents the media from a movie.
+
|ParamDescription=Quantity of results showed, with the maximum of 100
 +
}}
 +
{{Api_Parameter|
 +
ParamName=ItemTypeFilter
 +
|ParamType=[[ItemType]] (int)
 +
|ParamRequired=optional
 +
|ParamDescription=Defines a [[ItemType]] filter, to filter the results depending on the movie type value.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=adultFilter
 +
|ParamType=[[AdultFilterType]] (int)
 +
|ParamRequired=optional
 +
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=tagType
 +
|ParamType=Array of [[TagType]]
 +
|ParamRequired=optional
 +
|ParamDescription=Allows to filter the tag results depending on the TagType. The operator is able to introduce a comma separated list of TagTypes. Contents having ANY (OR operator) of the tags will be included in results.
 +
}}
 +
{{Api_Parameter|
 +
ParamName=ItemIds
 +
|ParamType=List of comma separated values of ItemIds
 +
|ParamRequired=optional
 +
|ParamDescription=Allows to filter the results depending on the Movie IDs (Comma separated list). It can only be used if one specific ItemType is selected (to avoid collisions)
 +
}}
 +
 
 +
 +
|Returns=
 +
Returns a JSON object containing an array of [[ItemTags]]
 +
 
 +
'''Objects are sorted by the most recent date of (any) tag creation'''. This is: the first item to be returned will be the movie with the most recent tag "event".  
 +
 
 +
'''Example:'''
 +
 
 +
{
 +
:    <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
 +
:    <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
 +
:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
 +
:    <span style="color: #a11;">"List"</span>:
 +
::    [ <span style="color: #219;">Array of [[ItemTags]] objects</span> ]
 +
}
 +
 
 +
 
 +
|Exceptions=
 +
* [[AuthenticationRequiredException]]
 +
* [[InvalidUserException]]
 +
* [[AuthenticationRequiredException]]
 +
* [[InvalidAdultFilterTypeException]]
 +
* [[InvalidTagTypeException]]
 +
* [[InvalidTypeFilterException]]
 +
* [[InvalidItemException]]
 +
* [[GutenTagException]]
 +
 
 +
 
 +
|Cache=
 +
This method is not cached.
 +
 
 +
|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"
 +
! 3.0
 +
{{!}} Initial method design
 +
{{!}} Jose Manuel Escartín
 +
{{!}}- valign="top"
 +
! 25.3
 +
{{!}} Migration to Blender API
 +
{{!}} Rafael Morón Abad
 +
{{!}}}
 +
 
 +
|SeeAlso=
 
}}
 
}}

Revision as of 13:43, 12 May 2025

Description

Method provided by Blender as of TVOPEN 25.3

Get a list of ItemTags objects, based on Resumes Service.

The user must be logged to use this method.

Parameters

  • token (String, required)
A valid token for identifying the API session context. Anonymous access is not allowed.
  • offset (int, optional)
Index of the initial result of the list, begins with 0
  • limit (int, optional)
Quantity of results showed, with the maximum of 100
  • ItemTypeFilter (ItemType (int), optional)
Defines a ItemType filter, to filter the results depending on the movie type value.
AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
  • tagType (Array of TagType, optional)
Allows to filter the tag results depending on the TagType. The operator is able to introduce a comma separated list of TagTypes. Contents having ANY (OR operator) of the tags will be included in results.
  • ItemIds (List of comma separated values of ItemIds, optional)
Allows to filter the results depending on the Movie IDs (Comma separated list). It can only be used if one specific ItemType is selected (to avoid collisions)


Returns

Returns a JSON object containing an array of ItemTags

Objects are sorted by the most recent date of (any) tag creation. This is: the first item to be returned will be the movie with the most recent tag "event".

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"List":
[ Array of ItemTags objects ]

}


Exceptions


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
3.0 Initial method design Jose Manuel Escartín
25.3 Migration to Blender API Rafael Morón Abad


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=GetMediaUrlStb_(Blender)&oldid=4526"