Difference between revisions of "GetAllChannels"

From Gvp-public
Jump to navigation Jump to search
Line 13: Line 13:
 
|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. The token can be anonymous or logged.
 
}}
 
}}
{{Api_Parameter|
+
 
ParamName=offset
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The offset number of the returned values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The limit number of values for this request
 
 
}}
 
}}
  
  
 
|Returns=
 
|Returns=
Returns a JSON object containing an array of [[Channel]].
+
Returns a JSON object containing a Token (Toobox).
  
 
'''Example:'''
 
'''Example:'''
Line 36: Line 26:
 
:    <span style="color: #a11">"Limit"</span>: 100,
 
:    <span style="color: #a11">"Limit"</span>: 100,
 
:    <span style="color: #a11">"Count"</span>: 6,
 
:    <span style="color: #a11">"Count"</span>: 6,
:    <span style="color: #a11">"List"</span>:
+
:    <span style="color: #a11">"Content"</span>:
::        [ Array of [[Channel]] object ]
+
::        Token: "479dfd9dca6281e97c9dcab03dd7045c780eceaeaa3be35caae12b3d1280bfaac2aaaffbda4865cf806a8649cddbe753"
 
}
 
}
  
  
 
|Exceptions=
 
|Exceptions=
None
+
* AccessDeniedException (84)
  
 
|Cache=
 
|Cache=
This method is cached.
+
This method is not cached.
  
 
|KnownIssues=
 
|KnownIssues=
Line 58: Line 48:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
! 1.0
+
! 3.2
 
{{!}} Initial method design
 
{{!}} Initial method design
{{!}} Harley Cabral
+
{{!}} Alberto Los Santos
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  

Revision as of 12:53, 4 March 2016

Description

Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration.

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.


Returns

{{{Returns}}}


Exceptions

{{{Exceptions}}}


Caching

{{{Cache}}}


Known issues

{{{KnownIssues}}}


Version history

{{{VersionHistory}}}


See also

{{{SeeAlso}}}


|Returns= Returns a JSON object containing a Token (Toobox).

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"Content":
Token: "479dfd9dca6281e97c9dcab03dd7045c780eceaeaa3be35caae12b3d1280bfaac2aaaffbda4865cf806a8649cddbe753"

}


|Exceptions=

  • AccessDeniedException (84)

|Cache= This method is not cached.

|KnownIssues= None

|VersionHistory=

API Version Number Change description Changes author
3.2 Initial method design Alberto Los Santos

|SeeAlso=

}}