Rating System: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
((Imported from MoinMoin))
(preference to hide ratings currently doesn't exist (https://tickets.metabrainz.org/browse/MBS-4089))
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
=MusicBrainz Rating System=

==Description==
==Description==


The rating system allows users to rate MusicBrainz entities (artists, labels, releases and tracks).
Rating is a new feature which is currently being develloped (Oct 2008), and which should be integrated in the 2008 server release.

Users will be able to rates [[MusicBrainz]] entities (artists, labels, releases and tracks).


==Details==
==Details==


Each user will be a number between 0 and 5. Then the system will aggregate users ratings to compute the average rating.
User may assign a value between 1 and 5 to various entities as a rating, these values are then aggregated by the server to compute an average community rating for that same entity.

The community rating is shown by default for each entity, however, once a user submits their own rating that value will be shown instead.

==Color Definitions==

{|
|-
| [[Image:star_big_unrated.gif]] || [[Image:star_small_unrated.gif]] || Unrated
|-
| [[Image:star_big_hover.gif]] || [[Image:star_small_hover.gif]] || Hover
|-
| [[Image:star_big_user-rated.gif]] || [[Image:star_small_user-rated.gif]] || User rating
|-
| [[Image:star_big_community-rated.gif]] || [[Image:star_small_community-rated.gif]] || Community rating
|}


==Web Service==
Only the aggregate rating will be display with stars. Individual rating will be only shown when viewing the affected entity in order to save server load.


The [[XML Web Service]] has been updated in order to allow to retrieve or update ratings via WS in a similar way to how [[Folksonomy Tagging|folksonomy tagging]] works.
==Web service==


The two methods of submission/retrieval are:
The [[XML Web Service|XMLWebService]] will be updated in order to allow to retrieve or update rating via WS in a similar way to how [[Folksonomy Tagging|FolksonomyTagging]] works. <pre>wget --user=<editor name> --password=<password> --post-data=id=8f6bd1e4-fbe1-4f50-aa9b-94c450ec0f11\&entity=artist\&rating=3 http://test.musicbrainz.org/ws/1/rating
# Using the new /rating resource for submitting/retrieving one specific rating.
</pre>
#: <code>wget --user=<editor name> --password=<password> --post-data=id=8f6bd1e4-fbe1-4f50-aa9b-94c450ec0f11\&entity=artist\&rating=3 http://test.musicbrainz.org/ws/1/rating</code>
# Using the two new inc parameters with the artist, label, release or tracks resources as described in [[XML Web Service]].
#: <code>ratings</code> and <code>user-ratings</code>


[[Category:Documentation]] [[Category:To Be Reviewed]]
---
[[Category:To Be Reviewed]] [[Category:Documentation]]

Revision as of 00:22, 3 February 2020

Description

The rating system allows users to rate MusicBrainz entities (artists, labels, releases and tracks).

Details

User may assign a value between 1 and 5 to various entities as a rating, these values are then aggregated by the server to compute an average community rating for that same entity.

The community rating is shown by default for each entity, however, once a user submits their own rating that value will be shown instead.

Color Definitions

star big unrated.gif star small unrated.gif Unrated
star big hover.gif star small hover.gif Hover
star big user-rated.gif star small user-rated.gif User rating
star big community-rated.gif star small community-rated.gif Community rating

Web Service

The XML Web Service has been updated in order to allow to retrieve or update ratings via WS in a similar way to how folksonomy tagging works.

The two methods of submission/retrieval are:

  1. Using the new /rating resource for submitting/retrieving one specific rating.
    wget --user=<editor name> --password=<password> --post-data=id=8f6bd1e4-fbe1-4f50-aa9b-94c450ec0f11\&entity=artist\&rating=3 http://test.musicbrainz.org/ws/1/rating
  2. Using the two new inc parameters with the artist, label, release or tracks resources as described in XML Web Service.
    ratings and user-ratings