Difference between revisions of "GetUserRights"

From Gvp-public
Jump to navigation Jump to search
Line 16: Line 16:
  
 
|Returns=
 
|Returns=
Returns a JSON object containing an array of UserRights objects.
+
Returns a JSON object containing an array of UserRights objects:
 +
: CatalogItemType: Type of the catalog Item associated
 +
: CatalogItemId: Id of the catalog Item
 +
: Quality: Quality of the pricing model that was used to purchase this catalog item
 +
: EndDate: End date of the User Right
 +
: IsAdult: Adult flag of the content
 +
: StatusId:  Status of the Purchase
 +
: DeviceTypeId: Device Type used to purchase de conent (0 means free subscription, 402 means top-down purchase)
 +
: PurchaseStartDate: Date of the purchase
  
 
'''Example:'''
 
'''Example:'''

Revision as of 07:59, 20 April 2017


Description

Return the list of the User rights.

This method only can be used by logged user.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.


Returns

Returns a JSON object containing an array of UserRights objects:

CatalogItemType: Type of the catalog Item associated
CatalogItemId: Id of the catalog Item
Quality: Quality of the pricing model that was used to purchase this catalog item
EndDate: End date of the User Right
IsAdult: Adult flag of the content
StatusId: Status of the Purchase
DeviceTypeId: Device Type used to purchase de conent (0 means free subscription, 402 means top-down purchase)
PurchaseStartDate: Date of the purchase

Example:

{

 "StatusCode": 0,
 "Severity": 1,
 "StatusMessage": "OK",
 "Content": {
   "Offset": 0,
   "Limit": 4,
   "Count": 4,
   "List": [
     {
       "CatalogItemType": 132,
       "CatalogItemId": 578,
       "Quality": 0,
       "EndDate": 1609455600,
       "IsAdult": false,
       "StatusId": 9,
       "DeviceTypeId": 402,
       "PurchaseStartDate": 1470927135
     },
     {
       "CatalogItemType": 132,
       "CatalogItemId": 601,
       "Quality": 0,
       "EndDate": 1609455600,
       "IsAdult": false,
       "StatusId": 9,
       "DeviceTypeId": 402,
       "PurchaseStartDate": 1470927134
     },
     {
       "CatalogItemType": 132,
       "CatalogItemId": 821,
       "Quality": 0,
       "EndDate": 1609455600,
       "IsAdult": false,
       "StatusId": 9,
       "DeviceTypeId": 402,
       "PurchaseStartDate": 1470927135
     },
     {
       "CatalogItemType": 132,
       "CatalogItemId": 103,
       "Quality": 0,
       "EndDate": 253402297199,
       "IsAdult": false,
       "StatusId": 0,
       "DeviceTypeId": 0,
       "PurchaseStartDate": 0
     }
   ]
 }

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
4.1 Initial method design José Manuel Escartín


See also