Difference between revisions of "GetChannel"
Jump to navigation
Jump to search
| Line 24: | Line 24: | ||
{ | { | ||
| − | : <span style="color: #a11">" | + | : <span style="color: #a11">"Status"</span>: 0, |
| − | : <span style="color: #a11">" | + | : <span style="color: #a11">"Severity"</span>: 1, |
| − | : <span style="color: #a11">" | + | : <span style="color: #a11">"StatusMessage"</span>: OK, |
: <span style="color: #a11">"Content"</span>: | : <span style="color: #a11">"Content"</span>: | ||
| − | :: { [[Channel]] object } | + | :: { |
| + | ::: [[Channel]] object | ||
| + | :: } | ||
} | } | ||
Latest revision as of 20:09, 4 June 2014
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
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- channelId (int, required)
- Id of the channel that wants to return the object information.
Returns
Returns a JSON object containing an object of Channel.
Example:
{
- "Status": 0,
- "Severity": 1,
- "StatusMessage": OK,
- "Content":
- {
- Channel object
- }
- {
}
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 |
