User:Nikki/ws/2: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(add annotation inc parameters)
(add area, place, series, instrument)
Line 173: Line 173:
|}
|}


== /ws/2/area/MBID ==
inc parameters:
{|
! Parameter !! Description
|-
| aliases || Aliases for this area
|-
| <tt>annotation</tt> || The annotation for this area
|-
| <tt>ratings</tt> || ???
|-
| <tt>tags</tt> || ???
|-
| <tt>user-tags</tt> || ??? (auth required)
|-
| <tt>user-ratings</tt> || ??? (auth required)
|-
| <tt>artist-rels</tt> || Relationships between this area and artists (currently none) [http://musicbrainz.org/relationships/area-artist]
|-
| <tt>release-group-rels</tt> || Relationships between this area and release groups (currently none) [http://musicbrainz.org/relationships/area-release_group]
|-
| <tt>release-rels</tt> || Relationships between this area and releases [http://musicbrainz.org/relationships/area-release]
|-
| <tt>recording-rels</tt> || Relationships between this area and recordings [http://musicbrainz.org/relationships/area-recording]
|-
| <tt>work-rels</tt> || Relationships between this area and works [http://musicbrainz.org/relationships/area-work]
|-
| <tt>url-rels</tt> || Relationships between this area and URLs [http://musicbrainz.org/relationships/area-url]
|-
| <tt>label-rels</tt> || Relationships between this area and labels (currently none) [http://musicbrainz.org/relationships/area-label]
|}


== /ws/2/place/MBID ==
inc parameters:
{|
! Parameter !! Description
|-
| aliases || Aliases for this place
|-
| <tt>annotation</tt> || The annotation for this place
|-
| <tt>ratings</tt> || ???
|-
| <tt>tags</tt> || ???
|-
| <tt>user-tags</tt> || ??? (auth required)
|-
| <tt>user-ratings</tt> || ??? (auth required)
|-
| <tt>artist-rels</tt> || Relationships between this place and artists [http://musicbrainz.org/relationships/artist-place]
|-
| <tt>release-group-rels</tt> || Relationships between this place and release groups [http://musicbrainz.org/relationships/place-release_group]
|-
| <tt>release-rels</tt> || Relationships between this place and releases [http://musicbrainz.org/relationships/place-release]
|-
| <tt>recording-rels</tt> || Relationships between this place and recordings [http://musicbrainz.org/relationships/place-recording]
|-
| <tt>work-rels</tt> || Relationships between this place and works [http://musicbrainz.org/relationships/place-work]
|-
| <tt>url-rels</tt> || Relationships between this place and URLs [http://musicbrainz.org/relationships/place-url]
|-
| <tt>label-rels</tt> || Relationships between this place and labels (currently none) [http://musicbrainz.org/relationships/label-place]
|}

== /ws/2/series/MBID ==
inc parameters:
{|
! Parameter !! Description
|-
| aliases || Aliases for this series
|-
| <tt>annotation</tt> || The annotation for this series
|-
| <tt>artist-rels</tt> || Relationships between this series and artists [http://musicbrainz.org/relationships/artist-series]
|-
| <tt>release-group-rels</tt> || Relationships between this series and release groups [http://musicbrainz.org/relationships/release_group-series]
|-
| <tt>release-rels</tt> || Relationships between this series and releases [http://musicbrainz.org/relationships/release-series]
|-
| <tt>recording-rels</tt> || Relationships between this series and recordings [http://musicbrainz.org/relationships/recording-series]
|-
| <tt>work-rels</tt> || Relationships between this series and works [http://musicbrainz.org/relationships/series-work]
|-
| <tt>url-rels</tt> || Relationships between this series and URLs [http://musicbrainz.org/relationships/series-url]
|-
| <tt>label-rels</tt> || Relationships between this series and labels (currently none) [http://musicbrainz.org/relationships/label-series]
|}

== /ws/2/instrument/MBID ==
inc parameters:
{|
! Parameter !! Description
|-
| aliases || Aliases for this instrument
|-
| <tt>annotation</tt> || The annotation for this instrument
|-
| <tt>artist-rels</tt> || Relationships between this instrument and artists (currently none) [http://musicbrainz.org/relationships/artist-instrument]
|-
| <tt>release-group-rels</tt> || Relationships between this instrument and release groups (currently none) [http://musicbrainz.org/relationships/instrument-release_group]
|-
| <tt>release-rels</tt> || Relationships between this instrument and releases (currently none) [http://musicbrainz.org/relationships/instrument-release]
|-
| <tt>recording-rels</tt> || Relationships between this instrument and recordings (currently none) [http://musicbrainz.org/relationships/instrument-recording]
|-
| <tt>work-rels</tt> || Relationships between this instrument and works (currently none) [http://musicbrainz.org/relationships/instrument-work]
|-
| <tt>url-rels</tt> || Relationships between this instrument and URLs [http://musicbrainz.org/relationships/instrument-url]
|-
| <tt>label-rels</tt> || Relationships between this instrument and labels (currently none) [http://musicbrainz.org/relationships/instrument-label]
|}


== /ws/2/url ==
== /ws/2/url ==

Revision as of 14:45, 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/area/MBID

inc parameters:

Parameter Description
aliases Aliases for this area
annotation The annotation for this area
ratings ???
tags ???
user-tags ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this area and artists (currently none) [29]
release-group-rels Relationships between this area and release groups (currently none) [30]
release-rels Relationships between this area and releases [31]
recording-rels Relationships between this area and recordings [32]
work-rels Relationships between this area and works [33]
url-rels Relationships between this area and URLs [34]
label-rels Relationships between this area and labels (currently none) [35]

/ws/2/place/MBID

inc parameters:

Parameter Description
aliases Aliases for this place
annotation The annotation for this place
ratings ???
tags ???
user-tags ??? (auth required)
user-ratings ??? (auth required)
artist-rels Relationships between this place and artists [36]
release-group-rels Relationships between this place and release groups [37]
release-rels Relationships between this place and releases [38]
recording-rels Relationships between this place and recordings [39]
work-rels Relationships between this place and works [40]
url-rels Relationships between this place and URLs [41]
label-rels Relationships between this place and labels (currently none) [42]

/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 [43]
release-group-rels Relationships between this series and release groups [44]
release-rels Relationships between this series and releases [45]
recording-rels Relationships between this series and recordings [46]
work-rels Relationships between this series and works [47]
url-rels Relationships between this series and URLs [48]
label-rels Relationships between this series and labels (currently none) [49]

/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) [50]
release-group-rels Relationships between this instrument and release groups (currently none) [51]
release-rels Relationships between this instrument and releases (currently none) [52]
recording-rels Relationships between this instrument and recordings (currently none) [53]
work-rels Relationships between this instrument and works (currently none) [54]
url-rels Relationships between this instrument and URLs [55]
label-rels Relationships between this instrument and labels (currently none) [56]

/ws/2/url

inc parameters:

Parameter Description
resource Required. The exact URL to look up
artist-rels Relationships between this URL and artists [57]
release-group-rels Relationships between this URL and release groups (currently none) [58]
release-rels Relationships between this URL and releases [59]
recording-rels Relationships between this URL and recordings [60]
work-rels Relationships between this URL and works [61]
url-rels Relationships between this URL and other URLs [62] (currently none)
label-rels Relationships between this URL and labels [63]

/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