GetInstanceInterests

From Gvp-public
Revision as of 09:51, 22 September 2015 by B.elp (talk | contribs) (Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user.
  • seriesId (int, required)
Id of the series to return the schedule.
  • startDate (int, required)
Starting time period for the query (long int).
  • endDate (int, required)
Ending time period for the query (long int)
  • liveChannelId (int, optional)
Channel ID.
  • offset (int, optional)
Index of the initial result of the list, begins with 0
  • limit (int, optional)
Quantity of results showed, with the maximum of 100.


Returns

Returns a JSON object with the list of series objects.

Example:

{

 "StatusCode": 0,
 "Severity": 1,
 "StatusMessage": "OK",
 "Content": {
   "Offset": 0,
   "Limit": 100,
   "Count": 0,
   "List": []
 }

}


Exceptions

TO BE COMPLETED


Caching

Known issues

None


Version history

TO BE COMPLETED


See also