Difference between revisions of "GetAllPlaylists"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use SearchContent instead}} {{Api_Method_Spec| Description=This method is deprecated. It retrieves...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[SearchContent]] instead}}
+
{{Deprecated|Message=This method has been deprecated in GVP 3.2.}}
  
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Line 28: Line 28:
  
 
|Returns=
 
|Returns=
 +
Returns a JSON object with a list of playlists.
  
 +
'''Example:'''
 +
 +
{
 +
  "StatusCode": 0,
 +
  "Severity": 1,
 +
  "StatusMessage": "OK",
 +
  "Content": {
 +
    "Offset": 0,
 +
    "Limit": 100,
 +
    "Count": 0,
 +
    "List": {
 +
      "TimeStamp": 0,
 +
      "Playlists": [ Array of playlists ]
 +
    }
 +
  }
 +
}
  
 
|Exceptions=
 
|Exceptions=
* None
+
<span style="color: #a11;">TO BE COMPLETED</span>
 +
 
  
 
|Cache=
 
|Cache=
Line 43: Line 61:
  
 
|SeeAlso=
 
|SeeAlso=
 +
* [[GetPlaylist]] method
 +
* [[GetPlaylists]] method
 +
* [[GetPlaylistMovies]] method
 +
  
 
}}
 
}}

Latest revision as of 08:13, 23 September 2015

Warning.png

This method has been deprecated in GVP 3.2.


Description

This method is deprecated. It retrieves the list of all playlists.

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


Returns

Returns a JSON object with a list of playlists.

Example:

{

 "StatusCode": 0,
 "Severity": 1,
 "StatusMessage": "OK",
 "Content": {
   "Offset": 0,
   "Limit": 100,
   "Count": 0,
   "List": {
     "TimeStamp": 0,
     "Playlists": [ Array of playlists ]
   }
 }

}


Exceptions

TO BE COMPLETED


Caching

This method is not cached.


Known issues

  • None


Version history

TO BE COMPLETED


See also