MyFavMirrors/owntone-server
1
0
Fork 0
mirror of https://github.com/owntone/owntone-server.git synced 2025-01-27 06:33:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

[docs] update for "usermark"

Browse Source
This commit is contained in:
whatdoineed2do/Ray 2021-09-16 10:51:54 +01:00
parent 4d5c256327
commit 45c5f0b347
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README_JSON_API.md
View File

@ -791,7 +791,7 @@ curl -X PUT "http://localhost:3689/api/queue/items/2"
| GET | [/api/library/albums/{id}/tracks](#list-album-tracks) | Get list of tracks for an album | | GET | [/api/library/albums/{id}/tracks](#list-album-tracks) | Get list of tracks for an album |
| GET | [/api/library/tracks/{id}](#get-a-track) | Get a track | | GET | [/api/library/tracks/{id}](#get-a-track) | Get a track |
| GET | [/api/library/tracks/{id}/playlists](#list-playlists-for-a-track) | Get list of playlists for a track | | GET | [/api/library/tracks/{id}/playlists](#list-playlists-for-a-track) | Get list of playlists for a track |
| PUT | [/api/library/tracks/{id}](#update-track-properties) | Update a tracks properties (rating, play_count) | | PUT | [/api/library/tracks/{id}](#update-track-properties) | Update a tracks properties (rating, play_count,usermark) |
| GET | [/api/library/genres](#list-genres) | Get list of genres | | GET | [/api/library/genres](#list-genres) | Get list of genres |
| GET | [/api/library/count](#get-count-of-tracks-artists-and-albums) | Get count of tracks, artists and albums | | GET | [/api/library/count](#get-count-of-tracks-artists-and-albums) | Get count of tracks, artists and albums |
| GET | [/api/library/files](#list-local-directories) | Get list of directories in the local library | | GET | [/api/library/files](#list-local-directories) | Get list of directories in the local library |
@ -1528,6 +1528,7 @@ curl -X GET "http://localhost:3689/api/library/track/1"
"disc_number": 1, "disc_number": 1,
"length_ms": 223170, "length_ms": 223170,
"rating": 0, "rating": 0,
"usermark": 0,
"play_count": 0, "play_count": 0,
"skip_count": 0, "skip_count": 0,
"time_added": "2019-01-20T11:58:29Z", "time_added": "2019-01-20T11:58:29Z",
@ -1601,7 +1602,7 @@ curl -X GET "http://localhost:3689/api/library/tracks/27/playlists"
### Update track properties ### Update track properties
Change properties of a specific track (supported properties are "rating" and "play_count") Change properties of a specific track (supported properties are "rating", "play_count" and "usermark")
**Endpoint** **Endpoint**
@ -1621,6 +1622,7 @@ PUT /api/library/tracks/{id}
| --------------- | ----------------------------------------------------------- | | --------------- | ----------------------------------------------------------- |
| rating | The new rating (0 - 100) | | rating | The new rating (0 - 100) |
| play_count | Either `increment` or `reset`. `increment` will increment `play_count` and update `time_played`, `reset` will set `play_count` and `skip_count` to zero and delete `time_played` and `time_skipped` | | play_count | Either `increment` or `reset`. `increment` will increment `play_count` and update `time_played`, `reset` will set `play_count` and `skip_count` to zero and delete `time_played` and `time_skipped` |
| usermark | The new usermark (>= 0) |
**Response** **Response**
@ -2565,6 +2567,7 @@ curl --include \
| path | string | Path | | path | string | Path |
| uri | string | Resource identifier | | uri | string | Resource identifier |
| artwork_url | string | *(optional)* [Artwork url](#artwork-urls) | | artwork_url | string | *(optional)* [Artwork url](#artwork-urls) |
| usermark | integer | User review marking of track (ranges from 0) |
### `paging` object ### `paging` object