Difference between revisions of "GetMediaUrlStb (Blender)"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
−
Description=
+
Description=Gets the multiple media URL for a movie (to be used on mediaroom)
−
Method provided by Blender as of TVOPEN 25.3
 
  
−
Get a list of [[ItemTags]] objects, based on Resumes Service.
+
|Parameters=
  
−
The user must be logged to use this method.
 
−
 
−
|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. Anonymous access is not allowed.
+
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=offset
+
ParamName=movieId
 
|ParamType=int
 
|ParamType=int
−
|ParamRequired=optional
+
|ParamRequired=required
−
|ParamDescription=Index of the initial result of the list, begins with 0
+
|ParamDescription=The movie id that represent an movie registered and available on the instance.
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
−
ParamName=limit
+
ParamName=mediaId
 
|ParamType=int
 
|ParamType=int
−
|ParamRequired=optional
+
|ParamRequired=required
−
|ParamDescription=Quantity of results showed, with the maximum of 100
+
|ParamDescription=An id from media id that represents the media from a movie.
−
}}
 
−
{{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=
−
Returns a JSON object containing an array of [[ItemTags]]
+
Returns a JSON object containing a [[MediaUrlResult]].
−
 
 
−
'''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:'''
 
'''Example:'''
  
 
{
 
{
−
:    <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
+
:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
−
:    <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
+
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
−
:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
+
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
−
:    <span style="color: #a11;">"List"</span>:  
+
:    <span style="color: #a11;">"Content"</span>:  
−
::    [ <span style="color: #219;">Array of [[ItemTags]] objects</span> ]
+
::    { <span style="color: #219;">Object of [[MediaUrlResult]]</span> }
 
}
 
}
−
 
  
 
|Exceptions=
 
|Exceptions=
−
* [[AuthenticationRequiredException]]
+
* None
−
* [[InvalidUserException]]
 
−
* [[AuthenticationRequiredException]]
 
−
* [[InvalidAdultFilterTypeException]]
 
−
* [[InvalidTagTypeException]]
 
−
* [[InvalidTypeFilterException]]
 
−
* [[InvalidItemException]]
 
−
* [[GutenTagException]]
 
−
 
 
  
 
|Cache=
 
|Cache=
Line 92: Line 53:
 
! Changes author
 
! Changes author
 
{{!}}- valign="top"
 
{{!}}- valign="top"
−
! 3.0
+
! 1.0
 
{{!}} Initial method design
 
{{!}} Initial method design
−
{{!}} Jose Manuel Escartín
+
{{!}} Harley Cabral
−
{{!}}- valign="top"
 
−
! 25.3
 
−
{{!}} Migration to Blender API
 
−
{{!}} Rafael Morón Abad
 
 
{{!}}}
 
{{!}}}
  
 
|SeeAlso=
 
|SeeAlso=
 
}}
 
}}

Revision as of 13:45, 12 May 2025

Description

Gets the multiple media URL for a movie (to be used on mediaroom)

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • movieId (int, required)
The movie id that represent an movie registered and available on the instance.
  • mediaId (int, required)
An id from media id that represents the media from a movie.


Returns

Returns a JSON object containing a MediaUrlResult.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
{ Object of MediaUrlResult }

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also

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