GetInstanceInterests - Revision history

B.elp at 12:04, 22 September 2015

2015-09-22T12:04:02Z

B.elp at 10:54, 22 September 2015

2015-09-22T10:54:59Z

B.elp at 10:38, 22 September 2015

2015-09-22T10:38:46Z

B.elp at 09:57, 22 September 2015

2015-09-22T09:57:05Z

B.elp at 09:56, 22 September 2015

2015-09-22T09:56:19Z

B.elp: Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP..."

2015-09-22T09:51:08Z

Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP..."

New page

{{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=

}}

@@ Line 57: / Line 57: @@
 |SeeAlso=
+* [[UNIAPI_Specification#Interest_Service| InterestService]] methods
 }}

@@ Line 48: / Line 48: @@
 |Cache=
+This method is not cached.
 |KnownIssues=

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=
+Description=For a determinated instance this method gets information about its interests. Token parameter is needed.
 |Parameters=

@@ Line 17: / Line 17: @@
 |Returns=
-Returns a JSON object with the list of series objects.
+Returns a JSON object with the list of objects.
 '''Example:'''

@@ Line 10: / Line 10: @@
 }}
 {{Api_Parameter|
-ParamName=seriesId
+ParamName=instanceId
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Id of the series to return the schedule.
+|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
 }}
@@ Line 50: / Line 20: @@
 '''Example:'''
+{
    "StatusCode": 0,
    "Severity": 1,
    "StatusMessage": "OK",
-   "Content": {
+   "Content": [
-    "Offset": 0,
-    "Limit": 100,
+      "ID": 12,
-    "Count": 0,
+      "Description": "Int_3_0_10 d",
-    "List": []
+      "Name": "Int_3_0_10",
+      "ResizableImages": [
+}