User:Nikki/ws/2: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(add annotation inc parameters)
Line 3: Line 3:
== /ws/2/artist/MBID ==
== /ws/2/artist/MBID ==
recordings (limited to 25), releases (limited to 25), release-groups (limited to 25), works (limited to 25)
recordings (limited to 25), releases (limited to 25), release-groups (limited to 25), works (limited to 25)
tags, ratings, user-tags, user-ratings
tags, ratings, user-tags, user-ratings, annotation
- artist-rels
- artist-rels
- label-rels
- label-rels
Line 25: Line 25:
|-
|-
| aliases || ???
| aliases || ???
|-
| <tt>annotation</tt> || The annotation for this release group
|-
|-
| <tt>ratings</tt> || Ratings for this release group
| <tt>ratings</tt> || Ratings for this release group
|-
|-
| <tt>tags</tt> || Tags for this release group
| <tt>tags</tt> || Tags for this release group
|-
|-
| <tt>user-tags</tt> || ??? (auth required)
| <tt>user-tags</tt> || ??? (auth required)
Line 34: Line 36:
| <tt>user-ratings</tt> || ??? (auth required)
| <tt>user-ratings</tt> || ??? (auth required)
|-
|-
| <tt>artist-rels</tt> || Relationships between this release group and artists [https://musicbrainz.org/relationships/artist-release_group]
| <tt>artist-rels</tt> || Relationships between this release group and artists [http://musicbrainz.org/relationships/artist-release_group]
|-
|-
| <tt>release-group-rels</tt> || Relationships between this release group and other release groups [https://musicbrainz.org/relationships/release_group-release_group]
| <tt>release-group-rels</tt> || Relationships between this release group and other release groups [http://musicbrainz.org/relationships/release_group-release_group]
|-
|-
| <tt>release-rels</tt> || Relationships between this release group and releases (currently none) [https://musicbrainz.org/relationships/release-release_group]
| <tt>release-rels</tt> || Relationships between this release group and releases (currently none) [http://musicbrainz.org/relationships/release-release_group]
|-
|-
| <tt>recording-rels</tt> || Relationships between this release group and recordings (currently none) [https://musicbrainz.org/relationships/recording-release_group]
| <tt>recording-rels</tt> || Relationships between this release group and recordings (currently none) [http://musicbrainz.org/relationships/recording-release_group]
|-
|-
| <tt>work-rels</tt> || Relationships between this release group and works (currently none) [https://musicbrainz.org/relationships/release_group-work]
| <tt>work-rels</tt> || Relationships between this release group and works (currently none) [http://musicbrainz.org/relationships/release_group-work]
|-
|-
| <tt>url-rels</tt> || Relationships between this release group and URLs [https://musicbrainz.org/relationships/release_group-url]
| <tt>url-rels</tt> || Relationships between this release group and URLs [http://musicbrainz.org/relationships/release_group-url]
|-
|-
| <tt>label-rels</tt> || Relationships between this release group and labels (currently none) [https://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]
|}
|}


Line 53: Line 55:
artists (limited to 25), labels (limited to 25), recordings (limited to 25), release-groups (limited to 25)
artists (limited to 25), labels (limited to 25), recordings (limited to 25), release-groups (limited to 25)
tags, user-tags
tags, user-tags
annotation
- artist-rels
- artist-rels
- label-rels
- label-rels
Line 76: Line 79:
|-
|-
| aliases || If "artists" is used (doesn't work with "artist-credits"), includes aliases for the artists in the artist credit.
| aliases || 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>ratings</tt> || Ratings for this recording
| <tt>ratings</tt> || Ratings for this recording
Line 85: Line 90:
| <tt>user-ratings</tt> || ??? (auth required)
| <tt>user-ratings</tt> || ??? (auth required)
|-
|-
| <tt>artist-rels</tt> || Relationships between this recording and artists [https://musicbrainz.org/relationships/artist-recording]
| <tt>artist-rels</tt> || Relationships between this recording and artists [http://musicbrainz.org/relationships/artist-recording]
|-
|-
| <tt>release-group-rels</tt> || Relationships between this recording and release groups (currently none) [https://musicbrainz.org/relationships/recording-release_group]
| <tt>release-group-rels</tt> || Relationships between this recording and release groups (currently none) [http://musicbrainz.org/relationships/recording-release_group]
|-
|-
| <tt>release-rels</tt> || Relationships between this recording and releases (currently none) [https://musicbrainz.org/relationships/recording-release]
| <tt>release-rels</tt> || Relationships between this recording and releases (currently none) [http://musicbrainz.org/relationships/recording-release]
|-
|-
| <tt>recording-rels</tt> || Relationships between this recording and other recordings [https://musicbrainz.org/relationships/recording-recording]
| <tt>recording-rels</tt> || Relationships between this recording and other recordings [http://musicbrainz.org/relationships/recording-recording]
|-
|-
| <tt>work-rels</tt> || Relationships between this recording and works [https://musicbrainz.org/relationships/recording-work]
| <tt>work-rels</tt> || Relationships between this recording and works [http://musicbrainz.org/relationships/recording-work]
|-
|-
| <tt>url-rels</tt> || Relationships between this recording and URLs [https://musicbrainz.org/relationships/recording-url]
| <tt>url-rels</tt> || Relationships between this recording and URLs [http://musicbrainz.org/relationships/recording-url]
|-
|-
| <tt>label-rels</tt> || Relationships between this recording and labels [https://musicbrainz.org/relationships/label-recording]
| <tt>label-rels</tt> || Relationships between this recording and labels [http://musicbrainz.org/relationships/label-recording]
|}
|}


Line 107: Line 112:
|-
|-
| aliases || Aliases for this work
| aliases || Aliases for this work
|-
| <tt>annotation</tt> || The annotation for this work
|-
|-
| <tt>ratings</tt> || Ratings for this work
| <tt>ratings</tt> || Ratings for this work
Line 116: Line 123:
| <tt>user-ratings</tt> || ??? (auth required)
| <tt>user-ratings</tt> || ??? (auth required)
|-
|-
| <tt>artist-rels</tt> || Relationships between this work and artists [https://musicbrainz.org/relationships/artist-work]
| <tt>artist-rels</tt> || Relationships between this work and artists [http://musicbrainz.org/relationships/artist-work]
|-
|-
| <tt>release-group-rels</tt> || Relationships between this work and release groups (currently none) [https://musicbrainz.org/relationships/release_group-work]
| <tt>release-group-rels</tt> || Relationships between this work and release groups (currently none) [http://musicbrainz.org/relationships/release_group-work]
|-
|-
| <tt>release-rels</tt> || Relationships between this work and releases (currently none) [https://musicbrainz.org/relationships/release-work]
| <tt>release-rels</tt> || Relationships between this work and releases (currently none) [http://musicbrainz.org/relationships/release-work]
|-
|-
| <tt>recording-rels</tt> || Relationships between this work and recordings [https://musicbrainz.org/relationships/recording-work]
| <tt>recording-rels</tt> || Relationships between this work and recordings [http://musicbrainz.org/relationships/recording-work]
|-
|-
| <tt>work-rels</tt> || Relationships between this work and other works [https://musicbrainz.org/relationships/work-work]
| <tt>work-rels</tt> || Relationships between this work and other works [http://musicbrainz.org/relationships/work-work]
|-
|-
| <tt>url-rels</tt> || Relationships between this work and URLs [https://musicbrainz.org/relationships/url-work]
| <tt>url-rels</tt> || Relationships between this work and URLs [http://musicbrainz.org/relationships/url-work]
|-
|-
| <tt>label-rels</tt> || Relationships between this work and labels [https://musicbrainz.org/relationships/label-work]
| <tt>label-rels</tt> || Relationships between this work and labels [http://musicbrainz.org/relationships/label-work]
|}
|}


Line 151: Line 158:
| <tt>user-ratings</tt> || ??? (auth required)
| <tt>user-ratings</tt> || ??? (auth required)
|-
|-
| <tt>artist-rels</tt> || Relationships between this label and artists [https://musicbrainz.org/relationships/artist-label]
| <tt>artist-rels</tt> || Relationships between this label and artists [http://musicbrainz.org/relationships/artist-label]
|-
|-
| <tt>release-group-rels</tt> || Relationships between this label and release groups (currently none) [https://musicbrainz.org/relationships/label-release_group]
| <tt>release-group-rels</tt> || Relationships between this label and release groups (currently none) [http://musicbrainz.org/relationships/label-release_group]
|-
|-
| <tt>release-rels</tt> || Relationships between this label and releases [https://musicbrainz.org/relationships/label-release]
| <tt>release-rels</tt> || Relationships between this label and releases [http://musicbrainz.org/relationships/label-release]
|-
|-
| <tt>recording-rels</tt> || Relationships between this label and recordings [https://musicbrainz.org/relationships/label-recording]
| <tt>recording-rels</tt> || Relationships between this label and recordings [http://musicbrainz.org/relationships/label-recording]
|-
|-
| <tt>work-rels</tt> || Relationships between this label and works [https://musicbrainz.org/relationships/label-work]
| <tt>work-rels</tt> || Relationships between this label and works [http://musicbrainz.org/relationships/label-work]
|-
|-
| <tt>url-rels</tt> || Relationships between this label and URLs [https://musicbrainz.org/relationships/label-url]
| <tt>url-rels</tt> || Relationships between this label and URLs [http://musicbrainz.org/relationships/label-url]
|-
|-
| <tt>label-rels</tt> || Relationships between this label and other labels [https://musicbrainz.org/relationships/label-label]
| <tt>label-rels</tt> || Relationships between this label and other labels [http://musicbrainz.org/relationships/label-label]
|}
|}


Line 175: Line 182:
| <tt>resource</tt> || Required. The exact URL to look up
| <tt>resource</tt> || Required. The exact URL to look up
|-
|-
| <tt>artist-rels</tt> || Relationships between this URL and artists [https://musicbrainz.org/relationships/artist-url]
| <tt>artist-rels</tt> || Relationships between this URL and artists [http://musicbrainz.org/relationships/artist-url]
|-
|-
| <tt>release-group-rels</tt> || Relationships between this URL and release groups (currently none) [https://musicbrainz.org/relationships/release_group-url]
| <tt>release-group-rels</tt> || Relationships between this URL and release groups (currently none) [http://musicbrainz.org/relationships/release_group-url]
|-
|-
| <tt>release-rels</tt> || Relationships between this URL and releases [https://musicbrainz.org/relationships/release-url]
| <tt>release-rels</tt> || Relationships between this URL and releases [http://musicbrainz.org/relationships/release-url]
|-
|-
| <tt>recording-rels</tt> || Relationships between this URL and recordings [https://musicbrainz.org/relationships/recording-url]
| <tt>recording-rels</tt> || Relationships between this URL and recordings [http://musicbrainz.org/relationships/recording-url]
|-
|-
| <tt>work-rels</tt> || Relationships between this URL and works [https://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 [https://musicbrainz.org/relationships/url-url] (currently none)
| <tt>url-rels</tt> || Relationships between this URL and other URLs [http://musicbrainz.org/relationships/url-url] (currently none)
|-
|-
| <tt>label-rels</tt> || Relationships between this URL and labels [https://musicbrainz.org/relationships/label-url]
| <tt>label-rels</tt> || Relationships between this URL and labels [http://musicbrainz.org/relationships/label-url]
|}
|}



Revision as of 14:31, 4 October 2014

Attempting to decipher Development/XML_Web_Service/Version_2.

/ws/2/artist/MBID

recordings (limited to 25), releases (limited to 25), release-groups (limited to 25), works (limited to 25) tags, ratings, user-tags, user-ratings, annotation

- artist-rels
- label-rels
- recording-rels
- release-rels
- release-group-rels
- url-rels
- work-rels


/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 ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this release group and artists [1]
release-group-rels Relationships between this release group and other release groups [2]
release-rels Relationships between this release group and releases (currently none) [3]
recording-rels Relationships between this release group and recordings (currently none) [4]
work-rels Relationships between this release group and works (currently none) [5]
url-rels Relationships between this release group and URLs [6]
label-rels Relationships between this release group and labels (currently none) [7]


/ws/2/release/MBID

artists (limited to 25), labels (limited to 25), recordings (limited to 25), release-groups (limited to 25) tags, user-tags annotation

- artist-rels
- label-rels
- recording-rels
- release-rels
- release-group-rels
- url-rels
- work-rels
- recording-level-rels
- work-level-rels


/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 ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this recording and artists [8]
release-group-rels Relationships between this recording and release groups (currently none) [9]
release-rels Relationships between this recording and releases (currently none) [10]
recording-rels Relationships between this recording and other recordings [11]
work-rels Relationships between this recording and works [12]
url-rels Relationships between this recording and URLs [13]
label-rels Relationships between this recording and labels [14]


/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 ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this work and artists [15]
release-group-rels Relationships between this work and release groups (currently none) [16]
release-rels Relationships between this work and releases (currently none) [17]
recording-rels Relationships between this work and recordings [18]
work-rels Relationships between this work and other works [19]
url-rels Relationships between this work and URLs [20]
label-rels Relationships between this work and labels [21]


/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 ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this label and artists [22]
release-group-rels Relationships between this label and release groups (currently none) [23]
release-rels Relationships between this label and releases [24]
recording-rels Relationships between this label and recordings [25]
work-rels Relationships between this label and works [26]
url-rels Relationships between this label and URLs [27]
label-rels Relationships between this label and other labels [28]


/ws/2/url

inc parameters:

Parameter Description
resource Required. The exact URL to look up
artist-rels Relationships between this URL and artists [29]
release-group-rels Relationships between this URL and release groups (currently none) [30]
release-rels Relationships between this URL and releases [31]
recording-rels Relationships between this URL and recordings [32]
work-rels Relationships between this URL and works [33]
url-rels Relationships between this URL and other URLs [34] (currently none)
label-rels Relationships between this URL and labels [35]

/ws/2/discid/DISCID

returns a list of releases inc = same as release toc = toc cdstub=no (optional, to turn off cd stubs)


/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