Difference between revisions of "GetSeriesSchedules"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=This method returns the schedule of all series contained in a period of time determinated by the user.
  
 
|Parameters=
 
|Parameters=
Line 65: Line 65:
  
 
|Exceptions=
 
|Exceptions=
 
+
<span style="color: #a11;">TO BE COMPLETED</span>
  
 
|Cache=
 
|Cache=
Line 74: Line 74:
  
 
|VersionHistory=
 
|VersionHistory=
 
+
<span style="color: #a11;">TO BE COMPLETED</span>
  
 
|SeeAlso=
 
|SeeAlso=
  
 
}}
 
}}

Revision as of 08:49, 22 September 2015

Description

This method returns the schedule of all series contained in a period of time determinated by the user.

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user.
  • seriesId (int, required)
  • 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

This method is not cached.


Known issues

None


Version history

TO BE COMPLETED


See also