Skip to content

Add clarifiaction on result of scrobble #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cquike wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add clarifiaction on result of scrobble #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions content/en/docs/Endpoints/scrobble.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "scrobble"
linkTitle: "scrobble"
opensubsonic:
- Clarification
categories:
- Media annotation
description: >
Expand Down Expand Up @@ -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.
Copy link
Copy Markdown
Member

@lachlan-00 lachlan-00 Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If all id values are invalid" and you would get this pull through


{{< 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 >}}
3 changes: 2 additions & 1 deletion openapi/endpoints/scrobble.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
{
Expand Down