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 available in the instance and filters them depending on the parameters provided. This method retriev..."
{{Api_Method_Spec|
Description=Returns the list of [[Subscription]] objects available in the instance and filters them depending on the parameters provided.
This method retrieves all the subscriptions (not taking into account [[SubscriptionPurchaseType]] (Top Down, Bottom Up and Both) and filters them depending on the typeFilter parameter provided (see [[SubscriptionType]]). If no typeFilter is provided, this method returns all the subscriptions.
Then it filters the resulting subscriptions applying childrenProductType filter. It will only return the Subscriptions that have children products associated (by Content Criteria) with Product Types that match the childrenProductType filter (see [[ProductType]]). If no childrenProductType filter is provided it will return subscriptions with any product types.
For example, if we provide ''childrenProductType = "2,3"'', it will only return subscriptions that contain Movie or Bundles.
|Parameters=
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=Comma separated list of [[SubscriptionType]] enumeration values (example "1,2,4") used to filter the result to return only the desired subscription types. If not provided it will return only Normal and AllPlaylist subscription types (default value = "1,4")
}}
{{Api_Parameter|
ParamName=childrenProductType
|ParamType=String
|ParamRequired=optional
|ParamDescription=Comma separated list of [[ProductType]] enumeration values (example "1,2,3,4") used to filter the result to return only subscriptions that contain any product matching the ProductType filter provided. If not provided it will return subscriptions with any product types.
}}
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{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=
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=
* [[SubscriptionType]] enumeration
* [[ProductType]] enumeration
* [[Subscription]] object
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods
}}
Description=Returns the list of [[Subscription]] objects available in the instance and filters them depending on the parameters provided.
This method retrieves all the subscriptions (not taking into account [[SubscriptionPurchaseType]] (Top Down, Bottom Up and Both) and filters them depending on the typeFilter parameter provided (see [[SubscriptionType]]). If no typeFilter is provided, this method returns all the subscriptions.
Then it filters the resulting subscriptions applying childrenProductType filter. It will only return the Subscriptions that have children products associated (by Content Criteria) with Product Types that match the childrenProductType filter (see [[ProductType]]). If no childrenProductType filter is provided it will return subscriptions with any product types.
For example, if we provide ''childrenProductType = "2,3"'', it will only return subscriptions that contain Movie or Bundles.
|Parameters=
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=Comma separated list of [[SubscriptionType]] enumeration values (example "1,2,4") used to filter the result to return only the desired subscription types. If not provided it will return only Normal and AllPlaylist subscription types (default value = "1,4")
}}
{{Api_Parameter|
ParamName=childrenProductType
|ParamType=String
|ParamRequired=optional
|ParamDescription=Comma separated list of [[ProductType]] enumeration values (example "1,2,3,4") used to filter the result to return only subscriptions that contain any product matching the ProductType filter provided. If not provided it will return subscriptions with any product types.
}}
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{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=
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=
* [[SubscriptionType]] enumeration
* [[ProductType]] enumeration
* [[Subscription]] object
* [[UNIAPI_Specification#Subscription Service|Subscription Service]] methods
}}
