Difference between revisions of "GetUserRights"

From Gvp-public
Jump to navigation Jump to search
(Created page with "To be edited by jose")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
To be edited by jose
+
 
 +
{{Api_Method_Spec|
 +
Description=Return the list of the User rights.
 +
 
 +
This method only can be used by logged user.
 +
 
 +
|Parameters=
 +
 
 +
{{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.
 +
}}
 +
 
 +
 
 +
|Returns=
 +
Returns a JSON object containing an array of UserRights objects:
 +
: '''CatalogItemType''': Type of the catalog Item associated [[CatalogItemType]]
 +
: '''CatalogItemId''': Id of the catalog Item
 +
: '''Quality''': Quality of the pricing model that was used to purchase this catalog item [[Quality]]
 +
: '''EndDate''': End date of the User Right
 +
: '''IsAdult''': Adult flag of the content
 +
: '''StatusId''':  Status of the Purchase (0 means that is the free subscription) [[PurchaseStatus]]
 +
: '''DeviceTypeId''': Device Type used to purchase de content (0 means free subscription, 402 means top-down purchase) [[DeviceType]]
 +
: '''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
 +
 
 +
|Cache=
 +
This method is not 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"
 +
! 4.1
 +
{{!}} Initial method design
 +
{{!}} José Manuel Escartín
 +
{{!}}}
 +
 
 +
|SeeAlso=
 +
}}

Latest revision as of 08:02, 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 CatalogItemType
CatalogItemId: Id of the catalog Item
Quality: Quality of the pricing model that was used to purchase this catalog item Quality
EndDate: End date of the User Right
IsAdult: Adult flag of the content
StatusId: Status of the Purchase (0 means that is the free subscription) PurchaseStatus
DeviceTypeId: Device Type used to purchase de content (0 means free subscription, 402 means top-down purchase) DeviceType
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

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=GetUserRights&oldid=1864"