User:Nikki/ws/2: Difference between revisions
(add missing *-rels includes) |
(authentication) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
== /ws/2/artist/MBID == |
== /ws/2/artist/MBID == |
||
inc parameters: |
|||
recordings (limited to 25), releases (limited to 25), release-groups (limited to 25), works (limited to 25) |
|||
{| |
|||
tags, ratings, user-tags, user-ratings, annotation |
|||
! Parameter !! Description |
|||
- artist-rels |
|||
|- |
|||
- label-rels |
|||
| <tt>recordings</tt> || ??? (limited to 25) |
|||
- recording-rels |
|||
|- |
|||
- release-rels |
|||
| <tt>releases</tt> || ??? (limited to 25) |
|||
- release-group-rels |
|||
|- |
|||
- url-rels |
|||
| <tt>release-groups</tt> || ??? (limited to 25) |
|||
- work-rels |
|||
|- |
|||
| <tt>works</tt> || ??? (limited to 25) |
|||
|- |
|||
| <tt>various-artists</tt> || ??? |
|||
|- |
|||
| <tt>aliases</tt> || ??? |
|||
|- |
|||
| <tt>annotation</tt> || The annotation for this artist |
|||
|- |
|||
| <tt>ratings</tt> || Ratings for this artist |
|||
|- |
|||
| <tt>tags</tt> || Tags for this artist |
|||
|- |
|||
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
|||
|- |
|||
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
|||
|- |
|||
| <tt>artist-rels</tt> || Relationships between this artist and other artists [http://musicbrainz.org/relationships/artist-artist] |
|||
|- |
|||
| <tt>release-group-rels</tt> || Relationships between this artist and release groups [http://musicbrainz.org/relationships/artist-release_group] |
|||
|- |
|||
| <tt>release-rels</tt> || Relationships between this artist and releases [http://musicbrainz.org/relationships/artist-release] |
|||
|- |
|||
| <tt>recording-rels</tt> || Relationships between this artist and recordings [http://musicbrainz.org/relationships/artist-recording] |
|||
|- |
|||
| <tt>work-rels</tt> || Relationships between this artist and works [http://musicbrainz.org/relationships/artist-work] |
|||
|- |
|||
| <tt>url-rels</tt> || Relationships between this artist and URLs [http://musicbrainz.org/relationships/artist-url] |
|||
|- |
|||
| <tt>label-rels</tt> || Relationships between this artist and labels [http://musicbrainz.org/relationships/artist-label] |
|||
|- |
|||
| <tt>area-rels</tt> || Relationships between this artist and areas (currently none) [http://musicbrainz.org/relationships/area-artist] |
|||
|- |
|||
| <tt>place-rels</tt> || Relationships between this artist and places [http://musicbrainz.org/relationships/artist-place] |
|||
|- |
|||
| <tt>series-rels</tt> || Relationships between this artist and series [http://musicbrainz.org/relationships/artist-series] |
|||
|- |
|||
| <tt>instrument-rels</tt> || Relationships between this artist and instruments (currently none) [http://musicbrainz.org/relationships/artist-instrument] |
|||
|} |
|||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>type</tt> || When used with the <tt>release-groups</tt> or <tt>releases</tt> inc parameters, limits the results to release groups with that type. |
|||
|- |
|||
| <tt>status</tt> || When used with the <tt>releases</tt> inc parameter, limits the results to releases with that status. |
|||
|} |
|||
== /ws/2/release-group/MBID == |
== /ws/2/release-group/MBID == |
||
Line 22: | Line 69: | ||
| <tt>releases</tt> || A list of releases in this release group (limited to 25) |
| <tt>releases</tt> || A list of releases in this release group (limited to 25) |
||
|- |
|- |
||
| artist-credits || The artist credit for the release group as well as artist credits for the releases in the release group when using inc=releases, for other entities when included via *-rels |
| <tt>artist-credits</tt> || The artist credit for the release group as well as artist credits for the releases in the release group when using inc=releases, for other entities when included via *-rels |
||
|- |
|- |
||
| aliases || ??? |
| <tt>aliases</tt> || ??? |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this release group |
| <tt>annotation</tt> || The annotation for this release group |
||
Line 32: | Line 79: | ||
| <tt>tags</tt> || Tags for this release group |
| <tt>tags</tt> || Tags for this release group |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this release group and artists [http://musicbrainz.org/relationships/artist-release_group] |
| <tt>artist-rels</tt> || Relationships between this release group and artists [http://musicbrainz.org/relationships/artist-release_group] |
||
Line 50: | Line 97: | ||
| <tt>label-rels</tt> || Relationships between this release group and labels (currently none) [http://musicbrainz.org/relationships/label-release_group] |
| <tt>label-rels</tt> || Relationships between this release group and labels (currently none) [http://musicbrainz.org/relationships/label-release_group] |
||
|- |
|- |
||
| <tt>area-rels</tt> || Relationships between this release group and areas [http://musicbrainz.org/relationships/area-release_group] |
| <tt>area-rels</tt> || Relationships between this release group and areas (currently none) [http://musicbrainz.org/relationships/area-release_group] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this release group and places [http://musicbrainz.org/relationships/place-release_group] |
| <tt>place-rels</tt> || Relationships between this release group and places [http://musicbrainz.org/relationships/place-release_group] |
||
Line 56: | Line 103: | ||
| <tt>series-rels</tt> || Relationships between this release group and series [http://musicbrainz.org/relationships/release_group-series] |
| <tt>series-rels</tt> || Relationships between this release group and series [http://musicbrainz.org/relationships/release_group-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this release group and instruments [http://musicbrainz.org/relationships/instrument-release_group] |
| <tt>instrument-rels</tt> || Relationships between this release group and instruments (currently none) [http://musicbrainz.org/relationships/instrument-release_group] |
||
|} |
|||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>status</tt> || When used with the <tt>releases</tt> inc parameter, limits the results to releases with that status. |
|||
|} |
|} |
||
== /ws/2/release/MBID == |
== /ws/2/release/MBID == |
||
inc parameters: |
|||
artists (limited to 25), labels (limited to 25), recordings (limited to 25), release-groups (limited to 25) |
|||
{| |
|||
tags, user-tags |
|||
! Parameter !! Description |
|||
annotation |
|||
|- |
|||
- artist-rels |
|||
| <tt>artists</tt> || ??? (limited to 25???) |
|||
- label-rels |
|||
|- |
|||
- recording-rels |
|||
| <tt>labels</tt> || ??? (limited to 25???) |
|||
- release-rels |
|||
|- |
|||
- release-group-rels |
|||
| <tt>recordings</tt> || ??? (limited to 25???) |
|||
- url-rels |
|||
|- |
|||
- work-rels |
|||
| <tt>release-groups</tt> || ??? (limited to 25???) |
|||
- recording-level-rels |
|||
|- |
|||
- work-level-rels |
|||
| <tt>annotation</tt> || The annotation for this release |
|||
|- |
|||
| <tt>ratings</tt> || ??? |
|||
|- |
|||
| <tt>tags</tt> || Tags for this release |
|||
|- |
|||
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
|||
|- |
|||
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
|||
|- |
|||
| <tt>artist-rels</tt> || Relationships between this release and artists [http://musicbrainz.org/relationships/artist-artist] |
|||
|- |
|||
| <tt>release-group-rels</tt> || Relationships between this release and release groups (currently none) [http://musicbrainz.org/relationships/release-release_group] |
|||
|- |
|||
| <tt>release-rels</tt> || Relationships between this release and other releases [http://musicbrainz.org/relationships/release-release] |
|||
|- |
|||
| <tt>recording-rels</tt> || Relationships between this release and recordings [http://musicbrainz.org/relationships/recording-release] |
|||
|- |
|||
| <tt>work-rels</tt> || Relationships between this release and works (currently none) [http://musicbrainz.org/relationships/release-work] |
|||
|- |
|||
| <tt>url-rels</tt> || Relationships between this release and URLs [http://musicbrainz.org/relationships/release-url] |
|||
|- |
|||
| <tt>label-rels</tt> || Relationships between this release and labels [http://musicbrainz.org/relationships/label-release] |
|||
|- |
|||
| <tt>area-rels</tt> || Relationships between this release and areas [http://musicbrainz.org/relationships/area-release] |
|||
|- |
|||
| <tt>place-rels</tt> || Relationships between this release and places [http://musicbrainz.org/relationships/place-release] |
|||
|- |
|||
| <tt>series-rels</tt> || Relationships between this release and series [http://musicbrainz.org/relationships/release-series] |
|||
|- |
|||
| <tt>instrument-rels</tt> || Relationships between this release and instruments (currently none) [http://musicbrainz.org/relationships/instrument-release] |
|||
|- |
|||
| <tt>recording-level-rels</tt> || ??? |
|||
|- |
|||
| <tt>work-level-rels</tt> || ??? |
|||
|} |
|||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>type</tt> || When used with the <tt>release-groups</tt> or <tt>releases</tt> inc parameters, limits the results to release groups with that type. |
|||
|} |
|||
== /ws/2/recording/MBID == |
== /ws/2/recording/MBID == |
||
Line 85: | Line 179: | ||
| <tt>artists</tt> || The artist credit for this recording (limited to 25???) |
| <tt>artists</tt> || The artist credit for this recording (limited to 25???) |
||
|- |
|- |
||
| artist-credits || The artist credit for this recording as well as artist credits for the releases using the recording when using inc=releases, for other entities when included via *-rels |
| <tt>artist-credits</tt> || The artist credit for this recording as well as artist credits for the releases using the recording when using inc=releases, for other entities when included via *-rels |
||
|- |
|- |
||
| aliases || If "artists" is used (doesn't work with "artist-credits"), includes aliases for the artists in the artist credit. |
| <tt>aliases</tt> || If "artists" is used (doesn't work with "artist-credits"), includes aliases for the artists in the artist credit. |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this recording |
| <tt>annotation</tt> || The annotation for this recording |
||
Line 95: | Line 189: | ||
| <tt>tags</tt> || Tags for this recording |
| <tt>tags</tt> || Tags for this recording |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this recording and artists [http://musicbrainz.org/relationships/artist-recording] |
| <tt>artist-rels</tt> || Relationships between this recording and artists [http://musicbrainz.org/relationships/artist-recording] |
||
Line 119: | Line 213: | ||
| <tt>series-rels</tt> || Relationships between this recording and series [http://musicbrainz.org/relationships/recording-series] |
| <tt>series-rels</tt> || Relationships between this recording and series [http://musicbrainz.org/relationships/recording-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this recording and instruments [http://musicbrainz.org/relationships/instrument-recording] |
| <tt>instrument-rels</tt> || Relationships between this recording and instruments (currently none) [http://musicbrainz.org/relationships/instrument-recording] |
||
|} |
|} |
||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>status</tt> || When used with the <tt>releases</tt> inc parameter, limits the results to releases with that status. |
|||
|} |
|||
== /ws/2/work/MBID == |
== /ws/2/work/MBID == |
||
Line 129: | Line 228: | ||
! Parameter !! Description |
! Parameter !! Description |
||
|- |
|- |
||
| aliases || Aliases for this work |
| <tt>aliases</tt> || Aliases for this work |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this work |
| <tt>annotation</tt> || The annotation for this work |
||
Line 137: | Line 236: | ||
| <tt>tags</tt> || Tags for this work |
| <tt>tags</tt> || Tags for this work |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this work and artists [http://musicbrainz.org/relationships/artist-work] |
| <tt>artist-rels</tt> || Relationships between this work and artists [http://musicbrainz.org/relationships/artist-work] |
||
Line 161: | Line 260: | ||
| <tt>series-rels</tt> || Relationships between this work and series [http://musicbrainz.org/relationships/series-work] |
| <tt>series-rels</tt> || Relationships between this work and series [http://musicbrainz.org/relationships/series-work] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this work and instruments [http://musicbrainz.org/relationships/instrument-work] |
| <tt>instrument-rels</tt> || Relationships between this work and instruments (currently none) [http://musicbrainz.org/relationships/instrument-work] |
||
|} |
|} |
||
Line 173: | Line 271: | ||
| <tt>releases</tt> || A list of releases using this label (limited to 25, do what for more?) |
| <tt>releases</tt> || A list of releases using this label (limited to 25, do what for more?) |
||
|- |
|- |
||
| artist-credits || Artist credits for the releases using this label when using inc=releases, for other entities when included via *-rels |
| <tt>artist-credits</tt> || Artist credits for the releases using this label when using inc=releases, for other entities when included via *-rels |
||
|- |
|- |
||
| aliases || Aliases for this label |
| <tt>aliases</tt> || Aliases for this label |
||
|- |
|- |
||
| <tt>ratings</tt> || Ratings for this label |
| <tt>ratings</tt> || Ratings for this label |
||
Line 181: | Line 279: | ||
| <tt>tags</tt> || Tags for this label |
| <tt>tags</tt> || Tags for this label |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this label and artists [http://musicbrainz.org/relationships/artist-label] |
| <tt>artist-rels</tt> || Relationships between this label and artists [http://musicbrainz.org/relationships/artist-label] |
||
Line 199: | Line 297: | ||
| <tt>label-rels</tt> || Relationships between this label and other labels [http://musicbrainz.org/relationships/label-label] |
| <tt>label-rels</tt> || Relationships between this label and other labels [http://musicbrainz.org/relationships/label-label] |
||
|- |
|- |
||
| <tt>area-rels</tt> || Relationships between this label and areas [http://musicbrainz.org/relationships/area-label] |
| <tt>area-rels</tt> || Relationships between this label and areas (currently none) [http://musicbrainz.org/relationships/area-label] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this label and places [http://musicbrainz.org/relationships/label-place] |
| <tt>place-rels</tt> || Relationships between this label and places (currently none) [http://musicbrainz.org/relationships/label-place] |
||
|- |
|- |
||
| <tt>series-rels</tt> || Relationships between this label and series [http://musicbrainz.org/relationships/label-series] |
| <tt>series-rels</tt> || Relationships between this label and series (currently none) [http://musicbrainz.org/relationships/label-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this label and instruments [http://musicbrainz.org/relationships/instrument-label] |
| <tt>instrument-rels</tt> || Relationships between this label and instruments (currently none) [http://musicbrainz.org/relationships/instrument-label] |
||
|} |
|||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>status</tt> || When used with the <tt>releases</tt> inc parameter, limits the results to releases with that status. |
|||
|} |
|} |
||
Line 214: | Line 318: | ||
! Parameter !! Description |
! Parameter !! Description |
||
|- |
|- |
||
| aliases || Aliases for this area |
| <tt>aliases</tt> || Aliases for this area |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this area |
| <tt>annotation</tt> || The annotation for this area |
||
Line 222: | Line 326: | ||
| <tt>tags</tt> || ??? |
| <tt>tags</tt> || ??? |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this area and artists (currently none) [http://musicbrainz.org/relationships/area-artist] |
| <tt>artist-rels</tt> || Relationships between this area and artists (currently none) [http://musicbrainz.org/relationships/area-artist] |
||
Line 242: | Line 346: | ||
| <tt>area-rels</tt> || Relationships between this area and other areas [http://musicbrainz.org/relationships/area-area] |
| <tt>area-rels</tt> || Relationships between this area and other areas [http://musicbrainz.org/relationships/area-area] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this area and places [http://musicbrainz.org/relationships/area-place] |
| <tt>place-rels</tt> || Relationships between this area and places (currently none) [http://musicbrainz.org/relationships/area-place] |
||
|- |
|- |
||
| <tt>series-rels</tt> || Relationships between this area and series [http://musicbrainz.org/relationships/area-series] |
| <tt>series-rels</tt> || Relationships between this area and series (currently none) [http://musicbrainz.org/relationships/area-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this area and instruments [http://musicbrainz.org/relationships/area-instrument] |
| <tt>instrument-rels</tt> || Relationships between this area and instruments [http://musicbrainz.org/relationships/area-instrument] |
||
|} |
|} |
||
Line 255: | Line 358: | ||
! Parameter !! Description |
! Parameter !! Description |
||
|- |
|- |
||
| aliases || Aliases for this place |
| <tt>aliases</tt> || Aliases for this place |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this place |
| <tt>annotation</tt> || The annotation for this place |
||
Line 263: | Line 366: | ||
| <tt>tags</tt> || ??? |
| <tt>tags</tt> || ??? |
||
|- |
|- |
||
| <tt>user-tags</tt> || ??? ( |
| <tt>user-tags</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>user-ratings</tt> || ??? ( |
| <tt>user-ratings</tt> || ??? ([[#Authentication|authentication required]]) |
||
|- |
|- |
||
| <tt>artist-rels</tt> || Relationships between this place and artists [http://musicbrainz.org/relationships/artist-place] |
| <tt>artist-rels</tt> || Relationships between this place and artists [http://musicbrainz.org/relationships/artist-place] |
||
Line 281: | Line 384: | ||
| <tt>label-rels</tt> || Relationships between this place and labels (currently none) [http://musicbrainz.org/relationships/label-place] |
| <tt>label-rels</tt> || Relationships between this place and labels (currently none) [http://musicbrainz.org/relationships/label-place] |
||
|- |
|- |
||
| <tt>area-rels</tt> || Relationships between this place and areas [http://musicbrainz.org/relationships/area-place] |
| <tt>area-rels</tt> || Relationships between this place and areas (currently none) [http://musicbrainz.org/relationships/area-place] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this place and other places [http://musicbrainz.org/relationships/place-place] |
| <tt>place-rels</tt> || Relationships between this place and other places [http://musicbrainz.org/relationships/place-place] |
||
|- |
|- |
||
| <tt>series-rels</tt> || Relationships between this place and series [http://musicbrainz.org/relationships/place-series] |
| <tt>series-rels</tt> || Relationships between this place and series (currently none) [http://musicbrainz.org/relationships/place-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this place and instruments [http://musicbrainz.org/relationships/instrument-place] |
| <tt>instrument-rels</tt> || Relationships between this place and instruments (currently none) [http://musicbrainz.org/relationships/instrument-place] |
||
|} |
|} |
||
Line 296: | Line 398: | ||
! Parameter !! Description |
! Parameter !! Description |
||
|- |
|- |
||
| aliases || Aliases for this series |
| <tt>aliases</tt> || Aliases for this series |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this series |
| <tt>annotation</tt> || The annotation for this series |
||
Line 314: | Line 416: | ||
| <tt>label-rels</tt> || Relationships between this series and labels (currently none) [http://musicbrainz.org/relationships/label-series] |
| <tt>label-rels</tt> || Relationships between this series and labels (currently none) [http://musicbrainz.org/relationships/label-series] |
||
|- |
|- |
||
| <tt>area-rels</tt> || Relationships between this series and areas [http://musicbrainz.org/relationships/area-series] |
| <tt>area-rels</tt> || Relationships between this series and areas (currently none) [http://musicbrainz.org/relationships/area-series] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this series and places [http://musicbrainz.org/relationships/place-series] |
| <tt>place-rels</tt> || Relationships between this series and places (currently none) [http://musicbrainz.org/relationships/place-series] |
||
|- |
|- |
||
| <tt>series-rels</tt> || Relationships between this series and other series [http://musicbrainz.org/relationships/series-series] |
| <tt>series-rels</tt> || Relationships between this series and other series (currently none) [http://musicbrainz.org/relationships/series-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this series and instruments [http://musicbrainz.org/relationships/instrument-series] |
| <tt>instrument-rels</tt> || Relationships between this series and instruments (currently none) [http://musicbrainz.org/relationships/instrument-series] |
||
|} |
|} |
||
Line 329: | Line 430: | ||
! Parameter !! Description |
! Parameter !! Description |
||
|- |
|- |
||
| aliases || Aliases for this instrument |
| <tt>aliases</tt> || Aliases for this instrument |
||
|- |
|- |
||
| <tt>annotation</tt> || The annotation for this instrument |
| <tt>annotation</tt> || The annotation for this instrument |
||
Line 349: | Line 450: | ||
| <tt>area-rels</tt> || Relationships between this instrument and areas [http://musicbrainz.org/relationships/area-instrument] |
| <tt>area-rels</tt> || Relationships between this instrument and areas [http://musicbrainz.org/relationships/area-instrument] |
||
|- |
|- |
||
| <tt>place-rels</tt> || Relationships between this instrument and places [http://musicbrainz.org/relationships/instrument-place] |
| <tt>place-rels</tt> || Relationships between this instrument and places (currently none) [http://musicbrainz.org/relationships/instrument-place] |
||
|- |
|- |
||
| <tt>series-rels</tt> || Relationships between this instrument and series [http://musicbrainz.org/relationships/instrument-series] |
| <tt>series-rels</tt> || Relationships between this instrument and series (currently none) [http://musicbrainz.org/relationships/instrument-series] |
||
|- |
|- |
||
| <tt>instrument-rels</tt> || Relationships between this instrument and other instruments [http://musicbrainz.org/relationships/instrument-instrument] |
| <tt>instrument-rels</tt> || Relationships between this instrument and other instruments [http://musicbrainz.org/relationships/instrument-instrument] |
||
|} |
|} |
||
Line 374: | Line 474: | ||
| <tt>work-rels</tt> || Relationships between this URL and works [http://musicbrainz.org/relationships/url-work] |
| <tt>work-rels</tt> || Relationships between this URL and works [http://musicbrainz.org/relationships/url-work] |
||
|- |
|- |
||
| <tt>url-rels</tt> || Relationships between this URL and other URLs [http://musicbrainz.org/relationships/url-url] |
| <tt>url-rels</tt> || Relationships between this URL and other URLs (currently none) [http://musicbrainz.org/relationships/url-url] |
||
|- |
|- |
||
| <tt>label-rels</tt> || Relationships between this URL and labels [http://musicbrainz.org/relationships/label-url] |
| <tt>label-rels</tt> || Relationships between this URL and labels [http://musicbrainz.org/relationships/label-url] |
||
Line 391: | Line 491: | ||
returns a list of releases |
returns a list of releases |
||
inc = same as release |
inc = same as release |
||
toc = toc |
|||
cdstub=no (optional, to turn off cd stubs) |
|||
other parameters: |
|||
{| |
|||
! Parameter !! Description |
|||
|- |
|||
| <tt>toc</tt> || A TOC which will be used for fuzzy lookup if no matching disc ID is found. |
|||
|- |
|||
| <tt>cdstub</tt> || When used with the value <tt>no</tt>, this causes [[CD Stub|CD stubs]] to not be included. |
|||
|- |
|||
| <tt>media-format</tt> || When used with the value <tt>all</tt>, the fuzzy TOC search will search all medium formats. By default, only CDs (really? or is it only things which allow disc IDs?) are searched. |
|||
|} |
|||
== /ws/2/puid/PUID == |
== /ws/2/puid/PUID == |
||
Line 409: | Line 517: | ||
returns a list of works |
returns a list of works |
||
inc = same as recording |
inc = same as recording |
||
== Authentication == |
|||
Requests which want to read user data (such as requests using inc parameters like <tt>user-tags</tt>) or change the database (which includes all POST requests) require authentication. |
|||
The authentication method used is HTTP Digest. The username and password are the same ones used for the main http://musicbrainz.org/ website. The realm is "musicbrainz.org". |
Latest revision as of 10:23, 5 October 2014
Attempting to decipher Development/XML_Web_Service/Version_2.
/ws/2/artist/MBID
inc parameters:
Parameter | Description |
---|---|
recordings | ??? (limited to 25) |
releases | ??? (limited to 25) |
release-groups | ??? (limited to 25) |
works | ??? (limited to 25) |
various-artists | ??? |
aliases | ??? |
annotation | The annotation for this artist |
ratings | Ratings for this artist |
tags | Tags for this artist |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this artist and other artists [1] |
release-group-rels | Relationships between this artist and release groups [2] |
release-rels | Relationships between this artist and releases [3] |
recording-rels | Relationships between this artist and recordings [4] |
work-rels | Relationships between this artist and works [5] |
url-rels | Relationships between this artist and URLs [6] |
label-rels | Relationships between this artist and labels [7] |
area-rels | Relationships between this artist and areas (currently none) [8] |
place-rels | Relationships between this artist and places [9] |
series-rels | Relationships between this artist and series [10] |
instrument-rels | Relationships between this artist and instruments (currently none) [11] |
other parameters:
Parameter | Description |
---|---|
type | When used with the release-groups or releases inc parameters, limits the results to release groups with that type. |
status | When used with the releases inc parameter, limits the results to releases with that status. |
/ws/2/release-group/MBID
inc parameters:
Parameter | Description |
---|---|
artists | The artist credit for this release group (limited to 25???) |
releases | A list of releases in this release group (limited to 25) |
artist-credits | The artist credit for the release group as well as artist credits for the releases in the release group when using inc=releases, for other entities when included via *-rels |
aliases | ??? |
annotation | The annotation for this release group |
ratings | Ratings for this release group |
tags | Tags for this release group |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this release group and artists [12] |
release-group-rels | Relationships between this release group and other release groups [13] |
release-rels | Relationships between this release group and releases (currently none) [14] |
recording-rels | Relationships between this release group and recordings (currently none) [15] |
work-rels | Relationships between this release group and works (currently none) [16] |
url-rels | Relationships between this release group and URLs [17] |
label-rels | Relationships between this release group and labels (currently none) [18] |
area-rels | Relationships between this release group and areas (currently none) [19] |
place-rels | Relationships between this release group and places [20] |
series-rels | Relationships between this release group and series [21] |
instrument-rels | Relationships between this release group and instruments (currently none) [22] |
other parameters:
Parameter | Description |
---|---|
status | When used with the releases inc parameter, limits the results to releases with that status. |
/ws/2/release/MBID
inc parameters:
Parameter | Description |
---|---|
artists | ??? (limited to 25???) |
labels | ??? (limited to 25???) |
recordings | ??? (limited to 25???) |
release-groups | ??? (limited to 25???) |
annotation | The annotation for this release |
ratings | ??? |
tags | Tags for this release |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this release and artists [23] |
release-group-rels | Relationships between this release and release groups (currently none) [24] |
release-rels | Relationships between this release and other releases [25] |
recording-rels | Relationships between this release and recordings [26] |
work-rels | Relationships between this release and works (currently none) [27] |
url-rels | Relationships between this release and URLs [28] |
label-rels | Relationships between this release and labels [29] |
area-rels | Relationships between this release and areas [30] |
place-rels | Relationships between this release and places [31] |
series-rels | Relationships between this release and series [32] |
instrument-rels | Relationships between this release and instruments (currently none) [33] |
recording-level-rels | ??? |
work-level-rels | ??? |
other parameters:
Parameter | Description |
---|---|
type | When used with the release-groups or releases inc parameters, limits the results to release groups with that type. |
/ws/2/recording/MBID
inc parameters:
Parameter | Description |
---|---|
releases | Releases which use this recording (limited to 25). |
artists | The artist credit for this recording (limited to 25???) |
artist-credits | The artist credit for this recording as well as artist credits for the releases using the recording when using inc=releases, for other entities when included via *-rels |
aliases | If "artists" is used (doesn't work with "artist-credits"), includes aliases for the artists in the artist credit. |
annotation | The annotation for this recording |
ratings | Ratings for this recording |
tags | Tags for this recording |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this recording and artists [34] |
release-group-rels | Relationships between this recording and release groups (currently none) [35] |
release-rels | Relationships between this recording and releases (currently none) [36] |
recording-rels | Relationships between this recording and other recordings [37] |
work-rels | Relationships between this recording and works [38] |
url-rels | Relationships between this recording and URLs [39] |
label-rels | Relationships between this recording and labels [40] |
area-rels | Relationships between this recording and areas [41] |
place-rels | Relationships between this recording and places [42] |
series-rels | Relationships between this recording and series [43] |
instrument-rels | Relationships between this recording and instruments (currently none) [44] |
other parameters:
Parameter | Description |
---|---|
status | When used with the releases inc parameter, limits the results to releases with that status. |
/ws/2/work/MBID
inc parameters:
Parameter | Description |
---|---|
aliases | Aliases for this work |
annotation | The annotation for this work |
ratings | Ratings for this work |
tags | Tags for this work |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this work and artists [45] |
release-group-rels | Relationships between this work and release groups (currently none) [46] |
release-rels | Relationships between this work and releases (currently none) [47] |
recording-rels | Relationships between this work and recordings [48] |
work-rels | Relationships between this work and other works [49] |
url-rels | Relationships between this work and URLs [50] |
label-rels | Relationships between this work and labels [51] |
area-rels | Relationships between this work and areas [52] |
place-rels | Relationships between this work and places [53] |
series-rels | Relationships between this work and series [54] |
instrument-rels | Relationships between this work and instruments (currently none) [55] |
/ws/2/label/MBID
inc parameters:
Parameter | Description |
---|---|
releases | A list of releases using this label (limited to 25, do what for more?) |
artist-credits | Artist credits for the releases using this label when using inc=releases, for other entities when included via *-rels |
aliases | Aliases for this label |
ratings | Ratings for this label |
tags | Tags for this label |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this label and artists [56] |
release-group-rels | Relationships between this label and release groups (currently none) [57] |
release-rels | Relationships between this label and releases [58] |
recording-rels | Relationships between this label and recordings [59] |
work-rels | Relationships between this label and works [60] |
url-rels | Relationships between this label and URLs [61] |
label-rels | Relationships between this label and other labels [62] |
area-rels | Relationships between this label and areas (currently none) [63] |
place-rels | Relationships between this label and places (currently none) [64] |
series-rels | Relationships between this label and series (currently none) [65] |
instrument-rels | Relationships between this label and instruments (currently none) [66] |
other parameters:
Parameter | Description |
---|---|
status | When used with the releases inc parameter, limits the results to releases with that status. |
/ws/2/area/MBID
inc parameters:
Parameter | Description |
---|---|
aliases | Aliases for this area |
annotation | The annotation for this area |
ratings | ??? |
tags | ??? |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this area and artists (currently none) [67] |
release-group-rels | Relationships between this area and release groups (currently none) [68] |
release-rels | Relationships between this area and releases [69] |
recording-rels | Relationships between this area and recordings [70] |
work-rels | Relationships between this area and works [71] |
url-rels | Relationships between this area and URLs [72] |
label-rels | Relationships between this area and labels (currently none) [73] |
area-rels | Relationships between this area and other areas [74] |
place-rels | Relationships between this area and places (currently none) [75] |
series-rels | Relationships between this area and series (currently none) [76] |
instrument-rels | Relationships between this area and instruments [77] |
/ws/2/place/MBID
inc parameters:
Parameter | Description |
---|---|
aliases | Aliases for this place |
annotation | The annotation for this place |
ratings | ??? |
tags | ??? |
user-tags | ??? (authentication required) |
user-ratings | ??? (authentication required) |
artist-rels | Relationships between this place and artists [78] |
release-group-rels | Relationships between this place and release groups [79] |
release-rels | Relationships between this place and releases [80] |
recording-rels | Relationships between this place and recordings [81] |
work-rels | Relationships between this place and works [82] |
url-rels | Relationships between this place and URLs [83] |
label-rels | Relationships between this place and labels (currently none) [84] |
area-rels | Relationships between this place and areas (currently none) [85] |
place-rels | Relationships between this place and other places [86] |
series-rels | Relationships between this place and series (currently none) [87] |
instrument-rels | Relationships between this place and instruments (currently none) [88] |
/ws/2/series/MBID
inc parameters:
Parameter | Description |
---|---|
aliases | Aliases for this series |
annotation | The annotation for this series |
artist-rels | Relationships between this series and artists [89] |
release-group-rels | Relationships between this series and release groups [90] |
release-rels | Relationships between this series and releases [91] |
recording-rels | Relationships between this series and recordings [92] |
work-rels | Relationships between this series and works [93] |
url-rels | Relationships between this series and URLs [94] |
label-rels | Relationships between this series and labels (currently none) [95] |
area-rels | Relationships between this series and areas (currently none) [96] |
place-rels | Relationships between this series and places (currently none) [97] |
series-rels | Relationships between this series and other series (currently none) [98] |
instrument-rels | Relationships between this series and instruments (currently none) [99] |
/ws/2/instrument/MBID
inc parameters:
Parameter | Description |
---|---|
aliases | Aliases for this instrument |
annotation | The annotation for this instrument |
artist-rels | Relationships between this instrument and artists (currently none) [100] |
release-group-rels | Relationships between this instrument and release groups (currently none) [101] |
release-rels | Relationships between this instrument and releases (currently none) [102] |
recording-rels | Relationships between this instrument and recordings (currently none) [103] |
work-rels | Relationships between this instrument and works (currently none) [104] |
url-rels | Relationships between this instrument and URLs [105] |
label-rels | Relationships between this instrument and labels (currently none) [106] |
area-rels | Relationships between this instrument and areas [107] |
place-rels | Relationships between this instrument and places (currently none) [108] |
series-rels | Relationships between this instrument and series (currently none) [109] |
instrument-rels | Relationships between this instrument and other instruments [110] |
/ws/2/url
inc parameters:
Parameter | Description |
---|---|
resource | Required. The exact URL to look up |
artist-rels | Relationships between this URL and artists [111] |
release-group-rels | Relationships between this URL and release groups (currently none) [112] |
release-rels | Relationships between this URL and releases [113] |
recording-rels | Relationships between this URL and recordings [114] |
work-rels | Relationships between this URL and works [115] |
url-rels | Relationships between this URL and other URLs (currently none) [116] |
label-rels | Relationships between this URL and labels [117] |
area-rels | Relationships between this URL and areas [118] |
place-rels | Relationships between this URL and places [119] |
series-rels | Relationships between this URL and series [120] |
instrument-rels | Relationships between this URL and instruments [121] |
/ws/2/discid/DISCID
returns a list of releases inc = same as release
other parameters:
Parameter | Description |
---|---|
toc | A TOC which will be used for fuzzy lookup if no matching disc ID is found. |
cdstub | When used with the value no, this causes CD stubs to not be included. |
media-format | When used with the value all, the fuzzy TOC search will search all medium formats. By default, only CDs (really? or is it only things which allow disc IDs?) are searched. |
/ws/2/puid/PUID
returns a list of recordings inc = same as recording
/ws/2/isrc/ISRC
returns a list of recordings inc = same as recording
/ws/2/iswc/ISWC
returns a list of works inc = same as recording
Authentication
Requests which want to read user data (such as requests using inc parameters like user-tags) or change the database (which includes all POST requests) require authentication.
The authentication method used is HTTP Digest. The username and password are the same ones used for the main http://musicbrainz.org/ website. The realm is "musicbrainz.org".