diff --git a/content/en/docs/Endpoints/scrobble.md b/content/en/docs/Endpoints/scrobble.md index 11596a0b..d2699cf8 100644 --- a/content/en/docs/Endpoints/scrobble.md +++ b/content/en/docs/Endpoints/scrobble.md @@ -1,6 +1,8 @@ --- title: "scrobble" linkTitle: "scrobble" +opensubsonic: +- Clarification categories: - Media annotation description: > @@ -55,3 +57,30 @@ An empty [`subsonic-response`](../../responses/subsonic-response) element on suc } {{< /tab >}} {{< /tabpane >}} + +If any `id` is invalid the result is an empty [`subsonic-response`](../../responses/subsonic-response) with error code 70 "The requested data was not found". Note that in this case the whole request has failed and no scrobbling should be performed for those `id` which are valid. + +{{< tabpane persist=false >}} +{{< tab header="OpenSubsonic" lang="json">}} +{ + "subsonic-response": { + "status": "failed", + "version": "1.16.1", + "type": "AwesomeServerName", + "serverVersion": "0.1.3 (tag)", + "openSubsonic": true, + "error": { + "code": 70, + "message": "The requested data was not found.", + "helpUrl": "https://example.org/scrobble" + } + } +} +{{< /tab >}} +{{< /tabpane >}} + +{{< alert color="warning" title="OpenSubsonic" >}} +In the original Subsonic, the the result is always succesful. + +For OpenSubsonic servers, the result is a failure if any of the `id` parameters is an invalid object. +{{< /alert >}} diff --git a/openapi/endpoints/scrobble.json b/openapi/endpoints/scrobble.json index 8dfdd4cd..a044a616 100644 --- a/openapi/endpoints/scrobble.json +++ b/openapi/endpoints/scrobble.json @@ -4,7 +4,8 @@ "description": "Registers the local playback of one or more media files. Typically used when playing media that is cached on the client. This operation includes the following:\n\n* “Scrobbles” the media files on last.fm if the user has configured his/her last.fm credentials on the server.\n* Updates the play count and last played timestamp for the media files. (Since 1.11.0)\n* Makes the media files appear in the “Now playing” page in the web app, and appear in the list of songs returned by getNowPlaying (Since 1.11.0)\n\nSince 1.8.0 you may specify multiple id (and optionally time) parameters to scrobble multiple files.", "operationId": "scrobble", "tags": [ - "Media Annotation" + "Media Annotation", + "Clarification" ], "parameters": [ {