GetUserTags

Description

Get a list of UserTags objects, containing contents (movies, episodes, series...) and the associated tags, including "resume info". Contents are previously tagged by the current user.

The user should be logged to use this method.

Parameters

• token (String, required)

A valid token for identifying the API session context. Anonymous access is not allowed.

• offset (int, optional)

Index of the initial result of the list, begins with 0

• limit (int, optional)

Quantity of results showed, with the maximum of 100

• typeFilter (MovieType (int), optional)

Defines a MovieType filter, to filter the results depending on the movie type value.

• adultFilter (AdultFilterType (int), optional)

AdultFilterType enum to filter the result required. The default value is NonAdultOnly.

• tag (TagType (int), optional)

Type of tag that wants to be filtered. The default value is Unknown.

• tagType (Array of TagType, optional)

Allows to filter the tag results depending on the TagType. The operator is able to introduce a comma separated list of TagTypes. Contents having ANY (OR operator) of the tags will be included in results.

• tagValue (Array of int, optional)

Allows to filter the results depending on the Movie IDs (Comma separated list).

Returns

Returns a JSON object containing an array of UserTags

Objects are sorted by the most recent date of (any) tag creation. This is: the first object (movie) to be returned will be the movie with the most recent tag "event". For example, if the sequential order of events is:

- Movie1 is tagged as watched

- Movie3 is tagged as watched

- Movie2 is tagged as watched

- Movie1 is tagged as completed

- Movie3 is tagged as completed

The sorting will be: movie3, movie1, movie2

Example:

{

"Offset": 0,

"Limit": 100,

"Count": 6,

"List":

[ Array of UserTags objects ]

}

Exceptions

• AuthenticationRequiredException

Caching

This method is not cached.

Known issues

• None

Version history

API Version Number	Change description	Changes author
3.0	Initial method design	Jose A. Jiménez