User:Nikki/ws/2: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(mark new *-rels inc parameters which have no types)
(expand artist)
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> || ???
|-
| aliases || ???
|-
| <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> || ??? (auth required)
|-
| <tt>user-ratings</tt> || ??? (auth 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]
|}


== /ws/2/release-group/MBID ==
== /ws/2/release-group/MBID ==

Revision as of 15:09, 4 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 ??? (auth required)
user-ratings ??? (auth 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]

/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 [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]


/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 [23]
release-group-rels Relationships between this recording and release groups (currently none) [24]
release-rels Relationships between this recording and releases (currently none) [25]
recording-rels Relationships between this recording and other recordings [26]
work-rels Relationships between this recording and works [27]
url-rels Relationships between this recording and URLs [28]
label-rels Relationships between this recording and labels [29]
area-rels Relationships between this recording and areas [30]
place-rels Relationships between this recording and places [31]
series-rels Relationships between this recording and series [32]
instrument-rels Relationships between this recording and instruments (currently none) [33]


/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 [34]
release-group-rels Relationships between this work and release groups (currently none) [35]
release-rels Relationships between this work and releases (currently none) [36]
recording-rels Relationships between this work and recordings [37]
work-rels Relationships between this work and other works [38]
url-rels Relationships between this work and URLs [39]
label-rels Relationships between this work and labels [40]
area-rels Relationships between this work and areas [41]
place-rels Relationships between this work and places [42]
series-rels Relationships between this work and series [43]
instrument-rels Relationships between this work and instruments (currently none) [44]


/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 [45]
release-group-rels Relationships between this label and release groups (currently none) [46]
release-rels Relationships between this label and releases [47]
recording-rels Relationships between this label and recordings [48]
work-rels Relationships between this label and works [49]
url-rels Relationships between this label and URLs [50]
label-rels Relationships between this label and other labels [51]
area-rels Relationships between this label and areas (currently none) [52]
place-rels Relationships between this label and places (currently none) [53]
series-rels Relationships between this label and series (currently none) [54]
instrument-rels Relationships between this label and instruments (currently none) [55]

/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) [56]
release-group-rels Relationships between this area and release groups (currently none) [57]
release-rels Relationships between this area and releases [58]
recording-rels Relationships between this area and recordings [59]
work-rels Relationships between this area and works [60]
url-rels Relationships between this area and URLs [61]
label-rels Relationships between this area and labels (currently none) [62]
area-rels Relationships between this area and other areas [63]
place-rels Relationships between this area and places (currently none) [64]
series-rels Relationships between this area and series (currently none) [65]
instrument-rels Relationships between this area and instruments [66]

/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 [67]
release-group-rels Relationships between this place and release groups [68]
release-rels Relationships between this place and releases [69]
recording-rels Relationships between this place and recordings [70]
work-rels Relationships between this place and works [71]
url-rels Relationships between this place and URLs [72]
label-rels Relationships between this place and labels (currently none) [73]
area-rels Relationships between this place and areas (currently none) [74]
place-rels Relationships between this place and other places [75]
series-rels Relationships between this place and series (currently none) [76]
instrument-rels Relationships between this place and instruments (currently none) [77]

/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 [78]
release-group-rels Relationships between this series and release groups [79]
release-rels Relationships between this series and releases [80]
recording-rels Relationships between this series and recordings [81]
work-rels Relationships between this series and works [82]
url-rels Relationships between this series and URLs [83]
label-rels Relationships between this series and labels (currently none) [84]
area-rels Relationships between this series and areas (currently none) [85]
place-rels Relationships between this series and places (currently none) [86]
series-rels Relationships between this series and other series (currently none) [87]
instrument-rels Relationships between this series and instruments (currently none) [88]

/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) [89]
release-group-rels Relationships between this instrument and release groups (currently none) [90]
release-rels Relationships between this instrument and releases (currently none) [91]
recording-rels Relationships between this instrument and recordings (currently none) [92]
work-rels Relationships between this instrument and works (currently none) [93]
url-rels Relationships between this instrument and URLs [94]
label-rels Relationships between this instrument and labels (currently none) [95]
area-rels Relationships between this instrument and areas [96]
place-rels Relationships between this instrument and places (currently none) [97]
series-rels Relationships between this instrument and series (currently none) [98]
instrument-rels Relationships between this instrument and other instruments [99]

/ws/2/url

inc parameters:

Parameter Description
resource Required. The exact URL to look up
artist-rels Relationships between this URL and artists [100]
release-group-rels Relationships between this URL and release groups (currently none) [101]
release-rels Relationships between this URL and releases [102]
recording-rels Relationships between this URL and recordings [103]
work-rels Relationships between this URL and works [104]
url-rels Relationships between this URL and other URLs [105] (currently none)
label-rels Relationships between this URL and labels [106]
area-rels Relationships between this URL and areas [107]
place-rels Relationships between this URL and places [108]
series-rels Relationships between this URL and series [109]
instrument-rels Relationships between this URL and instruments [110]

/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