Difference between revisions of "GetSubscriptionServices"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of LiveChannel objects available in the instance under a Subscription. The SubscriptionId should be sent in a request. The re...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
==== <span style="color:#7DC04E">THIS METHOD IS A DRAFT FOR GVP 2.4</span> ====
 +
 +
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Returns the list of [[LiveChannel]] objects available in the instance under a Subscription. The SubscriptionId should be sent in a request.
+
Description= Returns the list of [[Service]] objects available in the instance under a Subscription. The SubscriptionId should be sent in a request.
  
The result is default ordered by the property channel name in the object [[LiveChannel]].
+
The result is default ordered by ID of [[Service]].
  
 
|Parameters=
 
|Parameters=
Line 32: Line 35:
  
 
|Returns=
 
|Returns=
Returns a JSON object containing an array of [[LiveChannel]].
+
Returns a JSON object containing an array of [[Service]].
  
 
'''Example:'''
 
'''Example:'''
Line 41: Line 44:
 
:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
 
:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
 
:    <span style="color: #a11;">"List"</span>:  
 
:    <span style="color: #a11;">"List"</span>:  
::    [ <span style="color: #219;">Array of [[LiveChannel]] objects</span> ]
+
::    [ <span style="color: #219;">Array of [[Service]] objects</span> ]
 
}
 
}
  
Line 60: Line 63:
 
! Changes author
 
! Changes author
 
{{!}}- valign="top"
 
{{!}}- valign="top"
! 1.0
+
! 2.4
{{!}} Initial method design
+
{{!}} Initial method DRAFT design
{{!}} Harley Cabral
+
{{!}} Francisco Milagro
 
{{!}}}
 
{{!}}}
  
 
|SeeAlso=
 
|SeeAlso=
 
}}
 
}}

Latest revision as of 16:46, 2 June 2014

THIS METHOD IS A DRAFT FOR GVP 2.4

Description

Returns the list of Service objects available in the instance under a Subscription. The SubscriptionId should be sent in a request.

The result is default ordered by ID of Service.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • offset (int, optional)
The offset number of the returned values for this request
  • limit (int, optional)
The limit number of values for this request
  • subscriptionId (int, required)
The subscriptionId that wants request the data.


Returns

Returns a JSON object containing an array of Service.

Example:

{

"Offset": 0,
"Limit": 100,
"Count": 6,
"List":
[ Array of Service objects ]

}


Exceptions


Caching

This method is not cached.


Known issues

None


Version history

API Version Number Change description Changes author
2.4 Initial method DRAFT design Francisco Milagro


See also