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 | ||
}} | }} | ||
− | + | {{Api_Parameter| | |
+ | ParamName=TrackId | ||
+ | |ParamType=String | ||
+ | |ParamRequired=optional | ||
+ | |ParamDescription= | ||
+ | }} | ||
Revision as of 14:35, 15 July 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
- TrackId (String, optional)
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 |