Difference between revisions of "GetAllChannels"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration. This method can only be acc...")
 
Line 31: Line 31:
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">
 
{
 
{
  "Offset": 0,
+
:    <span style="color: #a11">"Offset"</span>: 0,
  "Limit": 100,
+
:    <span style="color: #a11">"Limit"</span>: 100,
  "Count": 6,
+
:    <span style="color: #a11">"Count"</span>: 6,
  "List":  
+
:    <span style="color: #a11">"List"</span>: {
    [Array of Channel objects]
+
::        [[Channel]] object
 +
:    }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 19:55, 4 June 2014

Description

Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration. This method can only be accessed with a valid logged token (not accessible by anonymous).

It automatically filters the results to return only enable channel in the logged Instance, including the adult channels.

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 containing an array of Channel.

Example:

{
:     <span style="color: #a11">"Offset"</span>: 0,
:     <span style="color: #a11">"Limit"</span>: 100,
:     <span style="color: #a11">"Count"</span>: 6,
:     <span style="color: #a11">"List"</span>: {
::        [[Channel]] object
:     }
}


Exceptions

None


Caching

This method is cached.


Known issues

None


Version history

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


See also