Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the list of Subscription objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by..."
{{Api_Method_Spec|
Description=Returns the list of [[Subscription]] objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous).
It automatically filters the results to return only subscription types Normal (1) and AllPlaylist (2) (see [[SubscriptionType]] enumeration).
It also filters out Subscriptions with [[SubscriptionPurchaseType]] = Provisioning Only, returning only Bottom Up and Both.
|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=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
|Returns=
Returns a JSON object containing an array of [[Subscription]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Subscription]] objects</span> ]
}
|Exceptions=
* [[StatusCode#InvalidDeviceTypeException|InvalidDeviceTypeException]]: If the token is not provided.
|Cache=
This method cannot be 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=
* [[SubscriptionTypes]] enumeration
* [[SubscriptionPurchaseType]] enumeration
* [[Subscription]] object
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods
}}
Description=Returns the list of [[Subscription]] objects that belong to the user. This method can only be accessed with a valid logged token (not accessible by anonymous).
It automatically filters the results to return only subscription types Normal (1) and AllPlaylist (2) (see [[SubscriptionType]] enumeration).
It also filters out Subscriptions with [[SubscriptionPurchaseType]] = Provisioning Only, returning only Bottom Up and Both.
|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=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
|Returns=
Returns a JSON object containing an array of [[Subscription]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[Subscription]] objects</span> ]
}
|Exceptions=
* [[StatusCode#InvalidDeviceTypeException|InvalidDeviceTypeException]]: If the token is not provided.
|Cache=
This method cannot be 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=
* [[SubscriptionTypes]] enumeration
* [[SubscriptionPurchaseType]] enumeration
* [[Subscription]] object
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods
}}
