GetChannels

From Gvp-public
Revision as of 19:55, 25 June 2014 by Rcalvo (talk | contribs) (Created page with "{{Api_Method_Spec| Description=Returns the list of Channel objects available in the instance from a list of Channel's ID. The result is default ordered by the property ID...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

Returns the list of Channel objects available in the instance from a list of Channel's ID.

The result is default ordered by the property ID in the object Channel. This method can be used by logged or anonymous login.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelIds (int, required)
List of Channel ID's that want to be returned the information.


Returns

Returns a JSON object containing an array of Channel.

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 4,
"List":
[ Array of Channel objects ]

}


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