Difference between revisions of "TagProduct"
Jump to navigation
Jump to search
| Line 36: | Line 36: | ||
|ParamDescription=The type must be: int when be TagType.Stars or bool for others type | |ParamDescription=The type must be: int when be TagType.Stars or bool for others type | ||
}} | }} | ||
| + | '''NEW IN 8.2!''' | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName=TrackId | + | ParamName=TrackId |
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Recommendation Id | |ParamDescription=Recommendation Id | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=UxReference | ||
| + | |ParamType=String | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Recommendation Reference | ||
}} | }} | ||
Latest revision as of 13:07, 10 August 2020
Description
Set the Tag for a product using a type and the productId passing a value for the tag.
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.
- productId (int, required)
- The ID of the product that wants to untag.
- productType (ProductType, required)
- The limit number of values for this request
- tagType (TagType, required)
- Tag type. This is a list of possible values (Enumeration).
- tagValue (String, required)
- The type must be: int when be TagType.Stars or bool for others type
NEW IN 8.2!
- TrackId (String, optional)
- Recommendation Id
- UxReference (String, optional)
- Recommendation Reference
Returns
Returns a JSON object containing a UserProduct with information about the tag.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": {
- Object of UserProduct
- }
}
Exceptions
- AuthenticationRequiredException
- InvalidMovieException
- InvalidBundleException
- InvalidPlaylistException
- InvalidSubscriptionException
- InvalidLiveChannelException
- InvalidProductException
- InvalidBooleanTagValueException
- InvalidTagTypeException
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
