Service
Jump to navigation
Jump to search
THIS DATA TYPE IS A DRAFT FOR GVP 2.4
Represents a Service object. Services provide access to an specific feature such as rPVR, nPVR, RestarTV, etc. Services are not purchased standalone, they are always commercialized inside Subscriptions.
Members
| Field | Data Type | Description |
|---|---|---|
| ID | int | Unique identifier for the Service |
| Name | String | The name for the Service |
| Description | String | A long description of the Service that will be shown to end users. |
| ServiceType | int | The value for the ServiceType enum that indicates the type of service. |
| DateStart | int | The commercialization start date (in Unix Timestamp) of the Service. Out of this time, the service cannot be purchased. |
| DateEnd | int | The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the service cannot be purchased. |
| ResizableImages | Array of Image object | NEW IN 2.3!
It provides the list of original images (non resized) associated with this Subscription. The application should use the Thumbox Service to perform dynamic resizing of the images in order to adapt them to the User Interface. |
| Status | int | Represents the Purchase Type of this subscription (BottomUp, TD or Both). See SubscriptionPurchaseType enumeration for more information. |
| Age Rating | AgeRating object | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| Stars | int | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| Tags | Array of UserTags object | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| 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. |
| CanAcquire | bool | Indicates if the user is able to purchase this subscription. The logic for calculating this is based on. |
| HaveVoDAccess | bool | Same as CanAcquire property, but.. |
| ChildCount | int | Indicates the count of objects that this Subscription provides. |
| DateIns | int | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| MediaRoomSync | bool | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| IsOtt | bool | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| IsIptv | bool | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| IsHybrid | bool | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| UpdateSender | bool | DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object. |
| Upgrade | Array of int | NEW IN 2.4. Returns an array of Subscription IDs that this Subscription has upgrade' relationship with. |
| Incompatible | Array of int | NEW IN 2.4. Returns an array of Subscription IDs that this Subscription has incompatible' relationship with. |
| RequiredDays | int | NEW IN 2.4. Number of days since the purchase that the user will not be able to perform upgrade operations having this subscription purchased until the time passes. Applications should use this information combined with CanWatch information to block users from purchasing subscriptions that have upgrade relationship with a Subscription that has not passed the required days. |
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,
- "Upgrade": [13,14],
- "Incompatible": [12,32,43,54,55],
- "RequiredDays": 45,
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial data type implementation | Harley Cabral |
| 2.3 | ResizableImages object added (for Thumbox resizing) | Francisco Milagro |
| 2.4 | Deprecated some member fields:
|
Francisco Milagro |
See also
- SubscriptionType enumeration
- SubscriptionStatus enumeration
- SubscriptionPurchaseType enumeration
- Image object
- CanWatch object
- SubscriptionService methods
- Thumbox Service for image resizing
