Difference between revisions of "GetMovieCommercialOffers"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Return ... |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identif...") |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Now a new '''Subscriptions''' field is returned for [[CatalogItem]] (inside [[ExtraMetadata]]), [[LiveChannel]] and [[LiveChannelsPlayback]], [[Movie]] and [[SimpleMovie]] API objects}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=Returns a list of subscription or bundles that contains the movie searched. It just return the subscription from Normal type. Other type doesn't return by this method. |
| + | The data returned is an array of [[Product]] object. This type of object is a cover for the other type of object like movie, subscription, bundle and playlist. If a movie is more of one product, it will return an array containing a list of each product that this product is assigned. | ||
| + | |||
| + | The method can be used by login or anonymous user. | ||
| + | |||
| + | (Method candidate to DEPRECATED in future versions) | ||
|Parameters= | |Parameters= | ||
| Line 31: | Line 38: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[Product]]. |
'''Example:''' | '''Example:''' | ||
| Line 39: | Line 46: | ||
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, | ||
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, | ||
| − | : <span style="color: #a11;">"Content"</span>: | + | : <span style="color: #a11;">"Content"</span>: { |
| − | :: | + | :: <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;">2</span>, | ||
| + | :: <span style="color: #a11;">"List"</span>: | ||
| + | ::: [ <span style="color: #219;">Array of [[Product]] objects</span> ] | ||
| + | : } | ||
} | } | ||
| Line 62: | Line 74: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| + | * [[CatalogItem]] | ||
| + | * [[ExtraMetadata]] | ||
| + | * [[LiveChannel]] | ||
| + | * [[LiveChannelsPlayback]] | ||
| + | * [[Movie]] | ||
| + | * [[SimpleMovie]] | ||
}} | }} | ||
Latest revision as of 06:39, 21 August 2015
This method has been deprecated in GVP 3.2. Now a new Subscriptions field is returned for CatalogItem (inside ExtraMetadata), LiveChannel and LiveChannelsPlayback, Movie and SimpleMovie API objects
Description
Returns a list of subscription or bundles that contains the movie searched. It just return the subscription from Normal type. Other type doesn't return by this method. The data returned is an array of Product object. This type of object is a cover for the other type of object like movie, subscription, bundle and playlist. If a movie is more of one product, it will return an array containing a list of each product that this product is assigned.
The method can be used by login or anonymous user.
(Method candidate to DEPRECATED in future versions)
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- movieId (int, required)
- ID of the movie
Returns
Returns a JSON object containing an array of Product.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": {
- "Offset": 0,
- "Limit": 100,
- "Count": 2,
- "List":
- [ Array of Product objects ]
- }
}
Exceptions
Caching
This method is cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 3.2 | Method deprecated | Francisco Milagro |
