Bureaucrats, editor
132
edits
Changes
Jump to navigation
Jump to search
GetInstanceInterests (view source)
Revision as of 09:51, 22 September 2015
, 09:51, 22 September 2015Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP..."
{{Api_Method_Spec|
Description=
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=seriesId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the series to return the schedule.
}}
{{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 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=
<span style="color: #a11;">TO BE COMPLETED</span>
|Cache=
|KnownIssues=
None
|VersionHistory=
<span style="color: #a11;">TO BE COMPLETED</span>
|SeeAlso=
}}
Description=
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=seriesId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the series to return the schedule.
}}
{{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 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=
<span style="color: #a11;">TO BE COMPLETED</span>
|Cache=
|KnownIssues=
None
|VersionHistory=
<span style="color: #a11;">TO BE COMPLETED</span>
|SeeAlso=
}}
