postUsersByUseridFavoriteitemsById
Marks an item as a favorite
Requires authentication as user
postUsersByUseridFavoriteitemsById
Request
post /Users/{UserId}/FavoriteItems/{Id}
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*UserId | path | User Id |
||
*Id | path | Item Id |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | UserItemDataDto | Operation successful. Returning a UserItemDataDto object. |
|
400 | Bad Request. Server cannot process request. |
||
401 | Unauthorized. Client needs to authenticate. |
||
403 | Forbidden. No permission for the reqested operation. |
||
404 | Resource not found or unavailable. |
||
500 | Server error. |
Definitions
UserItemDataDto
Name | Type | Notes |
---|---|---|
Rating | number (double) | The rating. |
PlayedPercentage | number (double) | The played percentage. |
UnplayedItemCount | integer (int32) | The unplayed item count. |
PlaybackPositionTicks | integer (int64) | The playback position ticks. |
PlayCount | integer (int32) | The play count. |
IsFavorite | boolean | A value indicating whether this instance is favorite. |
LastPlayedDate | string (date-time) | The last played date. |
Played | boolean | A value indicating whether this |
Key | string | The key. |
ItemId | string | The item identifier. |
ServerId | string | Used only by our Windows app. Not used by Emby Server. |