Difference between revisions of "GetUserTimestamps"

From Gvp-public
Jump to navigation Jump to search
 
(11 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
This method should be consumed through one of these approach:
 
This method should be consumed through one of these approach:
 
* Action based: When a action is performed from the devices and it may show recordings info: Access to EPG, Recordings section, etc.
 
* Action based: When a action is performed from the devices and it may show recordings info: Access to EPG, Recordings section, etc.
−
* Pol-ing in background each X minutes (configurable parameter required)
+
* Pol-ing in background each X minutes (configurable parameter required). The minimum recommended time for now is 5 mins (Avoid avalanches, make it random if devices init at the same time).
  
 
This method only can be used by logged user.
 
This method only can be used by logged user.
 +
 +
When does values change:
 +
 +
* Pins (TO BE DONE)
 +
** Currently it is same as UserTimestamp
 +
* Recordings
 +
** Cache time expires
 +
*** Because a recording is going to change state scheduled->ongoing, ongoing->finished
 +
*** Config (maximum cache time)
 +
*** Changes in series are performed directly in VRM, so those changes will not be reflected in the RecordingsTimestamp
 +
** New recording Added
 +
** Recording Cancelation
 +
** Recording Deletion
 +
** Recording protection
 +
* Rights (TO BE DONE)
 +
** Currently it is same as UserTimestamp
 +
* Services (TO BE DONE)
 +
** Currently it is same as UserTimestamp
 +
* Tags (TO BE DONE)
 +
** Currently it is same as UserTimestamp
 +
* Resumes
 +
** With resumes.api active: New resume info added
 +
** With resumes.api inactive: Equal to UserTimestamp
 +
 +
'''UserTimestamp changes when'''
 +
* Purchase is made/cancelled
 +
** gvp.gal (addMultipleSubscription, removeMultipleSubscription, addPpv, removePpv, extendRentalTime, cancelRental...)
 +
** gvp.api (createPurchase, createPurchaseStb, CancelPRoduct)
 +
* Tags changes
 +
** gvp.api (TagProduct, TagItem, RemoveUserWatchHistory..)
 +
* Services are activated/deactivated
 +
** gvp.api(AcceptUserAgreement, RemoveServiceAgreement)
 +
* Purchase status changes
 +
** gvp.gal.productsintegration
 +
* Pin is disabled
 +
** gvp.api (disablepin, EnablePin not changing timestamp)
 +
  
 
|Parameters=
 
|Parameters=
Line 31: Line 68:
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"Content"</span>: <span style="color: #219;">{</span>
 
:    <span style="color: #a11;">"Content"</span>: <span style="color: #219;">{</span>
−
:    <span style="color: #a11;">"Pins"</span>: <span style="color: #219;">1574415643</span>
+
:    <span style="color: #a11;">"Pins"</span>: <span style="color: #219;">1574415643,</span>
−
:    <span style="color: #a11;">"Recordings"</span>: <span style="color: #219;">1574674243</span>
+
:    <span style="color: #a11;">"Recordings"</span>: <span style="color: #219;">1574674243,</span>
−
:    <span style="color: #a11;">"Rights"</span>: <span style="color: #219;">1609459206</span>
+
:    <span style="color: #a11;">"Rights"</span>: <span style="color: #219;">1609459206,</span>
−
:    <span style="color: #a11;">"Services"</span>: <span style="color: #219;">1574415643</span>
+
:    <span style="color: #a11;">"Services"</span>: <span style="color: #219;">1574415643,</span>
 
:    <span style="color: #a11;">"Tags"</span>: <span style="color: #219;">1574415643</span>
 
:    <span style="color: #a11;">"Tags"</span>: <span style="color: #219;">1574415643</span>
 
:    <span style="color: #a11;">}</span>
 
:    <span style="color: #a11;">}</span>
Line 40: Line 77:
  
 
|Exceptions=
 
|Exceptions=
−
* None
+
* AuthenticationRequired: 30
  
 
|Cache=
 
|Cache=

Latest revision as of 10:22, 1 July 2020

Description

Returns different timestamps for each user info Currently only Recordings Timestamp is fully working, the rest of then CAN NOT be used

Devices should cache recordings info based on this timestamp, while it is not modified, the users recordings from cache are valid

This method should be consumed through one of these approach:

  • Action based: When a action is performed from the devices and it may show recordings info: Access to EPG, Recordings section, etc.
  • Pol-ing in background each X minutes (configurable parameter required). The minimum recommended time for now is 5 mins (Avoid avalanches, make it random if devices init at the same time).

This method only can be used by logged user.

When does values change:

  • Pins (TO BE DONE)
    • Currently it is same as UserTimestamp
  • Recordings
    • Cache time expires
      • Because a recording is going to change state scheduled->ongoing, ongoing->finished
      • Config (maximum cache time)
      • Changes in series are performed directly in VRM, so those changes will not be reflected in the RecordingsTimestamp
    • New recording Added
    • Recording Cancelation
    • Recording Deletion
    • Recording protection
  • Rights (TO BE DONE)
    • Currently it is same as UserTimestamp
  • Services (TO BE DONE)
    • Currently it is same as UserTimestamp
  • Tags (TO BE DONE)
    • Currently it is same as UserTimestamp
  • Resumes
    • With resumes.api active: New resume info added
    • With resumes.api inactive: Equal to UserTimestamp

UserTimestamp changes when

  • Purchase is made/cancelled
    • gvp.gal (addMultipleSubscription, removeMultipleSubscription, addPpv, removePpv, extendRentalTime, cancelRental...)
    • gvp.api (createPurchase, createPurchaseStb, CancelPRoduct)
  • Tags changes
    • gvp.api (TagProduct, TagItem, RemoveUserWatchHistory..)
  • Services are activated/deactivated
    • gvp.api(AcceptUserAgreement, RemoveServiceAgreement)
  • Purchase status changes
    • gvp.gal.productsintegration
  • Pin is disabled
    • gvp.api (disablepin, EnablePin not changing timestamp)

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 containning different timestamps

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": {
"Pins": 1574415643,
"Recordings": 1574674243,
"Rights": 1609459206,
"Services": 1574415643,
"Tags": 1574415643
}

}


Exceptions

  • AuthenticationRequired: 30


Caching

This method is not cached.


Known issues

  • None


Version history

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


See also

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