Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_DataType_Spec |Description=Represents a Subscription object. Subscriptions are packages that the user can purchase and provide access to other products such as Movies, Live..."
{{Api_DataType_Spec
|Description=Represents a Subscription object. Subscriptions are packages that the user can purchase and provide access to other products such as Movies, Live Channels, Services, etc. The Subscription will always have a recurring pricing model associated.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Subscription
{{!}}- valign="top"
! Title
{{!}} String
{{!}} The title for the subscription that will be shown to end users
{{!}}- valign="top"
! Description
{{!}} String
{{!}} A long description of the subscription that will be shown to end users.
{{!}}- valign="top"
! ShortDescription
{{!}} String
{{!}} A short description of the subscription that will be shown to end users.
{{!}}- valign="top"
! DateStart
{{!}} int
{{!}} The commercialization start date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
{{!}}- valign="top"
! DateEnd
{{!}} int
{{!}} The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
{{!}}- valign="top"
! Icon
{{!}} [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
{{!}}- valign="top"
! Banner
{{!}} [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
{{!}}- valign="top"
! Type
{{!}} int
{{!}} Represents the subscription type (enumeration). See [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration for more information.
{{!}}- valign="top"
! Status
{{!}} int
{{!}} Represents the subscription status (enumeration). See [[UNIAPI_Specification#SubscriptionStatus| SubscriptionStatus]] enumeration for more information.
{{!}}- valign="top"
! TrialDays
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Images
{{!}} Array of [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.3, the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] should be used to perform dynamic resizing of images. For backwards compatibility, the resized images will be returned by providing the thumbox url for the images with the different sizes defined in GVP_IMAGE_PROFILE_PRODUCT_TYPE table in MIB.
{{!}}- valign="top"
! ResizableImages
{{!}} Array of [[Image]] object
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 2.3!'''
It provides the list of original images (non resized) associated with this Subscription. The application should use the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] to perform dynamic resizing of the images in order to adapt them to the User Interface.
{{!}}- valign="top"
! Status
{{!}} int
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
{{!}}- valign="top"
! Age Rating
{{!}} [[AgeRating]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Stars
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Tags
{{!}} Array of [[UserTags]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! CanWatch
{{!}} [[CanWatch]] object
{{!}} Indicates the grants of this subscription for the current user. Provides the information if the user owns this Subscription, the pricing model used, etc.
{{!}}- valign="top"
! CanAcquire
{{!}} bool
{{!}} bgcolor="orange" {{!}} Indicates if the user is able to purchase this subscription. The logic for calculating this is based on.
{{!}}- valign="top"
! HaveVoDAccess
{{!}} bool
{{!}} bgcolor="orange" {{!}} Same as CanAcquire property, but..
{{!}}- valign="top"
! ChildCount
{{!}} int
{{!}} bgcolor="orange" {{!}} Indicates the count of objects that this Subscription provides.
{{!}}- valign="top"
! DateIns
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! MediaRoomSync
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsOtt
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsIptv
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsHybrid
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! UpdateSender
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
{{!}}}
|Example=
{
: "ID": 51,
: "Title": "GVP2.0_RFA_SG_TSA",
: "Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
: "ShortDescription": "Short description about this purchase",
: "DateStart": 1339538400,
: "DateEnd": 1434751200,
: "Type": 1,
: "Status": 1,
: "TrialDays": 0,
: "Images": [
:: Array of [[Image]] object
: ],
: "ResizableImages": [
:: Array of [[Image]] object
: ],
: "PurchaseType": 3,
: "CanWatch": {
:: [[CanWatch]] Object
: },
: "CanAcquire": true,
: "HaveVoDAccess": true,
: "ChildCount": 1,
: "IsOtt": true,
: "IsIptv": false,
: "IsHybrid": false,
}
|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 data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"
! 2.3
{{!}} ResizableImages object added (for Thumbox resizing)
{{!}} Francisco Milagro
{{!}}- valign="top"
! 2.4
{{!}} Deprecated some member fields:
* Icon
* Banner
* TrialDays
* Images
* AgeRating
* Stars
* Tags
* DateIns
* MediaRoomSync
* IsOtt
* IsIptv
* IsHybrid
* UpdateSender
{{!}} Francisco Milagro
{{!}}}
|SeeAlso=
* [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration
* [[UNIAPI_Specification#SubscriptionStatus|SubscriptionStatus]] enumeration
* [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration
* [[Image]] object
* [[CanWatch]] object
* [[UNIAPI_Specification#SubscriptionService|SubscriptionService]] methods
* [[UNIAPI_Specification#ThumboxService| Thumbox Service]] for image resizing
}}
|Description=Represents a Subscription object. Subscriptions are packages that the user can purchase and provide access to other products such as Movies, Live Channels, Services, etc. The Subscription will always have a recurring pricing model associated.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Subscription
{{!}}- valign="top"
! Title
{{!}} String
{{!}} The title for the subscription that will be shown to end users
{{!}}- valign="top"
! Description
{{!}} String
{{!}} A long description of the subscription that will be shown to end users.
{{!}}- valign="top"
! ShortDescription
{{!}} String
{{!}} A short description of the subscription that will be shown to end users.
{{!}}- valign="top"
! DateStart
{{!}} int
{{!}} The commercialization start date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
{{!}}- valign="top"
! DateEnd
{{!}} int
{{!}} The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
{{!}}- valign="top"
! Icon
{{!}} [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
{{!}}- valign="top"
! Banner
{{!}} [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
{{!}}- valign="top"
! Type
{{!}} int
{{!}} Represents the subscription type (enumeration). See [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration for more information.
{{!}}- valign="top"
! Status
{{!}} int
{{!}} Represents the subscription status (enumeration). See [[UNIAPI_Specification#SubscriptionStatus| SubscriptionStatus]] enumeration for more information.
{{!}}- valign="top"
! TrialDays
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Images
{{!}} Array of [[Image]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.3, the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] should be used to perform dynamic resizing of images. For backwards compatibility, the resized images will be returned by providing the thumbox url for the images with the different sizes defined in GVP_IMAGE_PROFILE_PRODUCT_TYPE table in MIB.
{{!}}- valign="top"
! ResizableImages
{{!}} Array of [[Image]] object
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 2.3!'''
It provides the list of original images (non resized) associated with this Subscription. The application should use the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] to perform dynamic resizing of the images in order to adapt them to the User Interface.
{{!}}- valign="top"
! Status
{{!}} int
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
{{!}}- valign="top"
! Age Rating
{{!}} [[AgeRating]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Stars
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! Tags
{{!}} Array of [[UserTags]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! CanWatch
{{!}} [[CanWatch]] object
{{!}} Indicates the grants of this subscription for the current user. Provides the information if the user owns this Subscription, the pricing model used, etc.
{{!}}- valign="top"
! CanAcquire
{{!}} bool
{{!}} bgcolor="orange" {{!}} Indicates if the user is able to purchase this subscription. The logic for calculating this is based on.
{{!}}- valign="top"
! HaveVoDAccess
{{!}} bool
{{!}} bgcolor="orange" {{!}} Same as CanAcquire property, but..
{{!}}- valign="top"
! ChildCount
{{!}} int
{{!}} bgcolor="orange" {{!}} Indicates the count of objects that this Subscription provides.
{{!}}- valign="top"
! DateIns
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! MediaRoomSync
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsOtt
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsIptv
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! IsHybrid
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
! UpdateSender
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
{{!}}- valign="top"
{{!}}}
|Example=
{
: "ID": 51,
: "Title": "GVP2.0_RFA_SG_TSA",
: "Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
: "ShortDescription": "Short description about this purchase",
: "DateStart": 1339538400,
: "DateEnd": 1434751200,
: "Type": 1,
: "Status": 1,
: "TrialDays": 0,
: "Images": [
:: Array of [[Image]] object
: ],
: "ResizableImages": [
:: Array of [[Image]] object
: ],
: "PurchaseType": 3,
: "CanWatch": {
:: [[CanWatch]] Object
: },
: "CanAcquire": true,
: "HaveVoDAccess": true,
: "ChildCount": 1,
: "IsOtt": true,
: "IsIptv": false,
: "IsHybrid": false,
}
|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 data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"
! 2.3
{{!}} ResizableImages object added (for Thumbox resizing)
{{!}} Francisco Milagro
{{!}}- valign="top"
! 2.4
{{!}} Deprecated some member fields:
* Icon
* Banner
* TrialDays
* Images
* AgeRating
* Stars
* Tags
* DateIns
* MediaRoomSync
* IsOtt
* IsIptv
* IsHybrid
* UpdateSender
{{!}} Francisco Milagro
{{!}}}
|SeeAlso=
* [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration
* [[UNIAPI_Specification#SubscriptionStatus|SubscriptionStatus]] enumeration
* [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration
* [[Image]] object
* [[CanWatch]] object
* [[UNIAPI_Specification#SubscriptionService|SubscriptionService]] methods
* [[UNIAPI_Specification#ThumboxService| Thumbox Service]] for image resizing
}}
