Bookmarks

Summary

Bookmarks enable a client application to store a position value for a content item and an account or user. Typically, the client application sets the position value automatically when the user stops a piece of content, or after prompting the user. This position value can be then be used to continue watching the content from the same position when viewed later. Therefore, whenever content is played back by a user, the application should first check whether a bookmark exists for the content, and if so, prompt the user as to whether they want to continue from the previous location.

Bookmarks should be deleted if content is played until the end, or the user decides to playback content from the beginning. Old bookmarks are periodically cleaned out by an automatic process. Typically, bookmarks that have not been modified for more than three months will be deleted.

Set Top Box applications that are user agnostic should set bookmarks on the account only. Open device applications should specify the user id as well as account when using bookmarks.

Bookmarks are device agnostic, so can be shared between devices for the account or user.

Data model

Bookmark data model

This is a JSON object with the following fields:

Name	Type	Description
`accountUid`	Long	The UID of the Account that owns the Bookmark.
`changeLog`	String	A log of the changes to this Entity history. This field is deprecated, and no longer visible to HUE List.
`contentType`	String	The type of content containing the Bookmark. One of: `AST` or `ASSET` for Asset `PRG` or `PROGRAM` for Program
`contentUid`	Long	The UID of the content item containing the Bookmark.
`creationDate`	Date	The date and time this Entity was created.
`exportID`	Integer	The identifier to use when exporting this Entity to third-party systems.
`modifiedDate`	Date	The date and time that this Entity was last modified in the database.
`originID`	Integer	An identifier for the system that owns this Entity. Identifiers up to 9999 are reserved for identifying systems pre-integrated with SDP. Operators can define their own meanings for values of 10000 and above.
`originIdAndKey`	Read-only string	A unique reference for the object, derived by joining the `originID` and `originKey`, together, with a pipe character `\|` to separate them.
`originKey`	String	The key or identifier that the system that owns this Entity uses to identify it.
`position`	Long	The position, in seconds, of the Bookmark within the content item's stream.
`serviceProviderID`	Long	The SDP internal UID for the Service Provider that created this Entity.
`uID`	Long	The SDP internal UID for this Entity.

Example

JS

{
    "UID" : 12,
    "accountUid" : 120,
    "contentType" : "ASSET",
    "position" : 336,
    "modifiedDate" : "07-02-14",
    "creationDate" : "20-03-14",
    "originID" : 2,
    "originKey" : "smilebaby",
    "serviceProviderID" : 12     
 }

12 reads

Use cases

The Bookmark Service is accessed directly on the User Activity Vault.

Creating a Bookmark for an account

In the example below, a bookmark is being created for the content "TDLA0100000088341751" on the account "AC1234":

CODE

PUT http://server:port//useractivityvault/v1/clientdata/account/AC1234/bookmarks/TDLA0100000088341751
Content-Type: application/json
token : 2HFAQk7EtPMyRGT787M9cExU3HeD
 
{"userId":"USR1234", "contentType":"ASSET", "position":"336", "creationDate":"2017-05-17T21:00:50.428Z"}

Creating a Bookmark for an account and user

In the example below, a bookmark is being created for the content "TDLA0100000088341751" on the account "AC1234" for user "USR1234":

CODE

PUT http://server:port//useractivityvault/v1/clientdata/account/AC1234/bookmarks/user/USR1234/TDLA0100000088341751
Content-Type: application/json
token : 2HFAQk7EtPMyRGT787M9cExU3HeD
 
{"contentType":"ASSET", "position":"336", "creationDate":"2017-05-17T21:00:50.428Z"}

Deleting a Bookmark

In the example below, the bookmark for the content "TDLA0100000088341751" is being deleted for the account "AC1234":

CODE

DELETE http://server:port//useractivityvault/v1/clientdata/account/AC1234/bookmarks/TDLA0100000088341751
Content-Type: application/json
token : 2HFAQk7EtPMyRGT787M9cExU3HeD

Getting Bookmarks for an account

In the example below, a list of the bookmarks on the account "AC1234" is being requested:

CODE

GET http://server:port//useractivityvault/v1/clientdata/account/AC1234/bookmarks
Content-Type: application/json
token : 2HFAQk7EtPMyRGT787M9cExU3HeD

Getting Bookmarks for an account and user

In the example below, a list of the bookmarks on the account "AC1234" for user "USR1234" is being requested:

CODE

GET http://server:port//useractivityvault/v1/clientdata/account/AC1234/user/USR1234/bookmarks
Content-Type: application/json
token : 2HFAQk7EtPMyRGT787M9cExU3HeD

Data model

Creating a Bookmark for an account

Creating a Bookmark for an account and user

Deleting a Bookmark

Getting Bookmarks for an account

Getting Bookmarks for an account and user

See also