editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Return a specific Channel object. Could be a Root Channel or any sub channel valid and active on the Instance configuration. This method can be..."
{{Api_Method_Spec|
Description=Return a specific [[Channel]] object. Could be a Root Channel or any sub channel valid and active on the Instance configuration. This method can be accessed with a valid logged token or anonymous.
It automatically filters the results to return only enable channel in the Instance, including the adult channels.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the channel that wants to return the object information.
}}
|Returns=
Returns a JSON object containing an object 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">"Content"</span>:
:: { [[Channel]] object }
}
|Exceptions=
None
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetAllChannels]]
}}
Description=Return a specific [[Channel]] object. Could be a Root Channel or any sub channel valid and active on the Instance configuration. This method can be accessed with a valid logged token or anonymous.
It automatically filters the results to return only enable channel in the Instance, including the adult channels.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the channel that wants to return the object information.
}}
|Returns=
Returns a JSON object containing an object 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">"Content"</span>:
:: { [[Channel]] object }
}
|Exceptions=
None
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[GetAllChannels]]
}}
