GetSeriesSchedules - Revision history

B.elp at 09:38, 22 September 2015

2015-09-22T09:38:55Z

B.elp at 08:49, 22 September 2015

2015-09-22T08:49:46Z

B.elp at 08:44, 22 September 2015

2015-09-22T08:44:51Z

B.elp at 08:44, 22 September 2015

2015-09-22T08:44:38Z

B.elp at 08:44, 22 September 2015

2015-09-22T08:44:06Z

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-22T08:25:45Z

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.
}}

|Returns=
Returns a JSON object with the list of [[Region]] objects.

'''Example:'''

{
: Array of [[Region]] objects
}

|Exceptions=
* None

|Cache=
This method is cached.

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}

|SeeAlso=
* [[ChannelMap]] object type
* [[UNIAPI_Specification#Epg_Service| Epg Service]] methods
}}

@@ Line 13: / Line 13: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=Id of the series to return the schedule.
 }}
 {{Api_Parameter|
@@ Line 19: / Line 19: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Starting time period for the query (long int)
+|ParamDescription=Starting time period for the query (long int).
 }}
 {{Api_Parameter|
@@ Line 31: / Line 31: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=Channel ID
+|ParamDescription=Channel ID.
 }}
 {{Api_Parameter|
@@ Line 43: / Line 43: @@
 |ParamType=int
 |ParamRequired=optional
-|ParamDescription=Quantity of results showed, with the maximum of 100
+|ParamDescription=Quantity of results showed, with the maximum of 100.
 }}

@@ Line 52: / Line 52: @@
+{
-:  "StatusCode": 0,
+  "StatusCode": 0,
    "Severity": 1,
    "StatusMessage": "OK",

@@ Line 53: / Line 53: @@
+{
 :  "StatusCode": 0,
-:  "Severity": 1,
+  "Severity": 1,
-:  "StatusMessage": "OK",
+  "StatusMessage": "OK",
-:  "Content": {
+  "Content": {
-:    "Offset": 0,
+    "Offset": 0,
-:    "Limit": 100,
+    "Limit": 100,
-:    "Count": 0,
+    "Count": 0,
-:    "List": []
+    "List": []
+   }
+}

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

@@ Line 8: / Line 8: @@
 |ParamRequired=required
 |ParamDescription=A valid token for identifying the API session context and logged user.
 }}
 |Returns=
-Returns a JSON object with the list of [[Region]] objects.
+Returns a JSON object with the list of series objects.
 '''Example:'''
+{
-:     Array of [[Region]] objects
+:  "StatusCode": 0,
+}
 |Exceptions=
-* None
 |Cache=
-This method is cached.
+This method is not cached.
 |KnownIssues=
@@ Line 30: / Line 74: @@
 |VersionHistory=
-{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
 |SeeAlso=
-* [[ChannelMap]] object type
 }}