Difference between revisions of "GetSeriesSchedules"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP...") |
|||
| Line 8: | Line 8: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A valid token for identifying the API session context and logged user. | |ParamDescription=A valid token for identifying the API session context and logged user. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=seriesId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription= | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=startDate | ||
| + | |ParamType=int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription=Starting time period for the query (long int) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=endDate | ||
| + | |ParamType=int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription=Ending time period for the query (long int) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=liveChannelId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Channel ID | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=offset | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Index of the initial result of the list, begins with 0 | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=limit | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Quantity of results showed, with the maximum of 100 | ||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object with the list of | + | Returns a JSON object with the list of series objects. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : | + | : "StatusCode": 0, |
| + | : "Severity": 1, | ||
| + | : "StatusMessage": "OK", | ||
| + | : "Content": { | ||
| + | : "Offset": 0, | ||
| + | : "Limit": 100, | ||
| + | : "Count": 0, | ||
| + | : "List": [] | ||
| + | } | ||
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | + | ||
|Cache= | |Cache= | ||
| − | This method is cached. | + | This method is not cached. |
|KnownIssues= | |KnownIssues= | ||
| Line 30: | Line 74: | ||
|VersionHistory= | |VersionHistory= | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|SeeAlso= | |SeeAlso= | ||
| − | + | ||
| − | |||
}} | }} | ||
Revision as of 08:44, 22 September 2015
Description
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
Caching
This method is not cached.
Known issues
None
