API Methods.2. Release(s) Methods

API Methods.2.1. release/byId
API Methods.2.2. release/byType
API Methods.2.3. release/byArtist
API Methods.2.4. release/byGenre
API Methods.2.5. release/bySeries
API Methods.2.6. release/byAddedDate

API Methods.2.1. release/byId

Description

Returns a release of specified id.

Endpoint

http://api.mp3caprice.com/1.0/release/byId/{releaseId}

Method Parameters

releaseId

positive integer value; specifies the release's id.

Result Structure

Release or Error

Result sorting order

Single release structure returned.

Method Example

Example API Methods.7. Get release by id

http://api.mp3caprice.com/1.0/release/byId/1.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <releaseId>1</releaseId>
 <releaseName>A Little South Of Sanity [Explicit]</releaseName>
 <artistId>1</artistId>
 <artistName>Aerosmith</artistName>
 <releaseType>Live</releaseType>
 <releaseSource>CD</releaseSource>
 <releaseLanguage>English</releaseLanguage>
 <releaseYear>1998</releaseYear>
 <tracksCount>23</tracksCount>
 <totalSize>277810622</totalSize>
 <totalPrice>3.45</totalPrice>
 <addedDate>2009-07-19</addedDate>
 <releaseUrl>
  http://mp3caprice.com/release/a-little-south-of-sanity-explicit--1?pid=P_00101
 </releaseUrl>
 <releaseLargeCoverUrl>
  http://cvr.mp3caprice.com/covers/albums/000/001/230.jpg
 </releaseLargeCoverUrl>
 <releaseSmallCoverUrl>
  http://cvr.mp3caprice.com/covers/albums/000/001/90.jpg
 </releaseSmallCoverUrl>
 <genres>
  <genre>
   <genreId>1</genreId>
   <genreName>Alternative Rock</genreName>
   <releasesCount>350</releasesCount>
   <genreUrl>
    http://mp3caprice.com/genre/alternative-rock-1?pid=P_00101
   </genreUrl>
  </genre>
  ...
 </genres>
 <tracks>
  <track>
   <releaseId>1</releaseId>
   <artistId>1</artistId>
   <artistName>Aerosmith</artistName>
   <trackName>Eat The Rich</trackName>
   <trackPosition>1</trackPosition>
   <discNumber>1</discNumber>
   <trackPrice>0.15</trackPrice>
   <trackLength>315</trackLength>
   <trackSize>12576910</trackSize>
   <trackBitrate>320</trackBitrate>
   <trackPreview>
    http://prv.mp3caprice.com/preview/000/000/6-32.mp3
   </trackPreview>
  </track>
  ...
 </tracks>
</apiResponse>
[Note]

To get release by id that equals 1 in json format use url like

http://api.mp3caprice.com/1.0/release/byId/1.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.2.2. release/byType

Description

Gets paginated releases filtered by type.

Releases are already sorted by released year in descending mode.

Endpoint

http://api.mp3caprice.com/1.0/release/byType/{pageSize}/{pageNumber}/{releaseType}

Method Parameters

pageSize

positive integer value; specifies the page size to be returned. Maximum allowed value is 50.

pageNumber

positive integer value; specifies the page number to be returned.

releaseType

enumerated value. Can be one of the following:

  • Album

  • Artist_Compilation

  • VA_Compilation

  • Live

  • Remix

  • Single

  • Soundtrack

Result Structure

Table API Methods.3. Releases by type result structure

Attribute Type Required Details
releaseType enum yes Release's type
Paginator attributes Paginator yes Paginated releases already filtered by specified type.

or Error

Result sorting order

Paginated release structures ordered by:

  • release.releaseYear - DESC

  • release.releaseName

Method Example

Example API Methods.8. Get first page of releases filtered by album type

http://api.mp3caprice.com/1.0/release/byType/10/1/Album.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <releaseType>Album</releaseType>
 <paginator>
  <pageNumber>1</pageNumber>
  <pageSize>10</pageSize>
  <pageCount>1195</pageCount>
  <pageItems>
   <item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="release">
    <releaseId>10505</releaseId>
    <releaseName>...And Then We Saw Land</releaseName>
    <artistId>9103</artistId>
    <artistName>Tunng</artistName>
    <releaseType>Album</releaseType>
    <releaseSource>CD</releaseSource>
    <releaseLanguage>English</releaseLanguage>
    <releaseYear>2010</releaseYear>
    <tracksCount>11</tracksCount>
    <totalSize>113964820</totalSize>
    <totalPrice>1.32</totalPrice>
    <addedDate>2010-06-14</addedDate>
    <releaseUrl>
     http://mp3caprice.com/release/-and-then-we-saw-land-10505?pid=P_00101
    </releaseUrl>
    <releaseLargeCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/010/505/230.jpg
    </releaseLargeCoverUrl>
    <releaseSmallCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/010/505/90.jpg
    </releaseSmallCoverUrl>
   </item>
   ...    
  </pageItems>
 </paginator>
</apiResponse>
[Note]

To get first page of releases filtered by release type in json format use url like

http://api.mp3caprice.com/1.0/release/byType/10/1/Album.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.2.3. release/byArtist

Description

Gets releases of artist filtered by release type.

Releases are already sorted by released year in descending order. To get full discography releaseType needs to be set to “All”.

Endpoint

http://api.mp3caprice.com/1.0/release/byArtist/{releaseType}/{artistId}

Method Parameters

releaseType

enumerated value. Can be one of the following:

  • Album

  • Artist_Compilation

  • VA_Compilation

  • Live

  • Remix

  • Single

  • Soundtrack

  • All

artistId

positive integer value; specifies artist’s id.

Result Structure

Table API Methods.4. Artist releases result structure

Attribute Type Required Details
artistId integer yes Mp3Caprice Artist’s id
filterReleaseType enum yes Type of release the response is sorted by if no filtering applied.
releases List of Releases yes Artist's releases already filtered by specified type.

or Error

Result sorting order

Paginated release structures ordered by:

  • release.releaseYear - DESC

  • release.releaseName

Method Example

Example API Methods.9. Get first page of artist’s releases filtered by type Album

http://api.mp3caprice.com/1.0/release/byArtist/Album/1.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <artistId>1</artistId>
 <filterReleaseType>Album</filterReleaseType>
 <releases>
  <release>
   <releaseId>172</releaseId>
   <releaseName>Honkin' on Bobo</releaseName>
   <artistId>1</artistId>
   <artistName>Aerosmith</artistName>
   <releaseType>Album</releaseType>
   <releaseSource>CD</releaseSource>
   <releaseLanguage>English</releaseLanguage>
   <releaseYear>2004</releaseYear>
   <tracksCount>12</tracksCount>
   <totalSize>111871860</totalSize>
   <totalPrice>1.8</totalPrice>
   <addedDate>2009-07-19</addedDate>
   <releaseUrl>
    http://mp3caprice.com/release/honkin-on-bobo-172?pid=P_00101
   </releaseUrl>
   <releaseLargeCoverUrl>
    http://cvr.mp3caprice.com/covers/albums/000/172/230.jpg
   </releaseLargeCoverUrl>
   <releaseSmallCoverUrl>
    http://cvr.mp3caprice.com/covers/albums/000/172/90.jpg
   </releaseSmallCoverUrl>
  </release>
  ...
 </releases>
</apiResponse>
[Note]

To get artist’s releases filtered by type Album in json format use url like

http://api.mp3caprice.com/1.0/release/byArtist/Album/1.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.2.4. release/byGenre

Description

Gets paginated releases corresponding to specified genre.

Releases are already sorted by released year in descending mode.

Endpoint

http://api.mp3caprice.com/1.0/release/byGenre/{pageSize}/{pageNumber}/{genreId}

Method Parameters

pageSize

positive integer value; specifies the page size to be returned. Maximum allowed value is 50.

pageNumber

positive integer value; specifies the page number to be returned.

genreId

positive integer value; specifies genre’s id.

Result Structure

Table API Methods.5. Genre releases result structure

Attribute Type Required Details
genreId integer yes Mp3Caprice Genre’s id
paginator Paginator yes Paginated releases corresponding to specified genre.

or Error

Result sorting order

Paginated release structures ordered by:

  • release.releaseYear - DESC

  • release.releaseName

Method Example

Example API Methods.10. Get first page of releases corresponding to genre with id that equals 1.

http://api.mp3caprice.com/1.0/release/byGenre/10/1/1.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <genreId>1</genreId>
 <paginator>
  <pageNumber>1</pageNumber>
  <pageSize>10</pageSize>
  <pageCount>160</pageCount>
  <pageItems>
   <item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="release">
    <releaseId>5881</releaseId>
    <releaseName>Now That'S What I Call The 00S</releaseName>
    <artistId>-1</artistId>
    <artistName>Various Artists</artistName>
    <releaseType>VA_Compilation</releaseType>
    <releaseSource>CD</releaseSource>
    <releaseLanguage>English</releaseLanguage>
    <releaseYear>2010</releaseYear>
    <tracksCount>60</tracksCount>
    <totalSize>519142654</totalSize>
    <totalPrice>7.2</totalPrice>
    <addedDate>2010-03-04</addedDate>
    <releaseUrl>
     http://mp3caprice.com/release/now-that-s-what-i-call-the-00s-5881?pid=P_00101
    </releaseUrl>
    <releaseLargeCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/005/881/230.jpg
    </releaseLargeCoverUrl>
    <releaseSmallCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/005/881/90.jpg
    </releaseSmallCoverUrl>
   </item>
   ...
  </pageItems>
 </paginator>
</apiResponse>
[Note]

To get first page of releases corresponding to genre with id that equals 1in json format use url like

http://api.mp3caprice.com/1.0/release/byGenre/10/1/1.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.2.5. release/bySeries

Description

Gets list of releases corresponding to specified series.

Endpoint

http://api.mp3caprice.com/1.0/release/bySeries/{seriesId}

Method Parameters

seriesId

positive integer value; specifies series’s id.

Result Structure

Table API Methods.6. Genre releases result structure

Attribute Type Required Details
series Series yes Series result structure corresponding to specified series Id.
releases List of Release yes List of releases corresponding to specified series Id

or Error

Result sorting order

Paginated release structures ordered by:

  • release.releaseYear - DESC

  • release.releaseName

Method Example

Example API Methods.11. Get list of releases by series id.

http://api.mp3caprice.com/1.0/release/bySeries/62.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <series>
  <seriesId>62</seriesId>
  <seriesName>Beautiful Voices</seriesName>
  <seriesUrl>
   http://mp3caprice.com/series/beautiful-voices-62?pid=P_00101
  </seriesUrl>
 </series>
 <releases>
  <release>
   <releaseId>16547</releaseId>
   <releaseName>
    Beautiful Voices 050 (Ambiental Trance Mix)
   </releaseName>
   <artistId>-1</artistId>
   <artistName>Various Artists</artistName>
   <releaseType>VA_Compilation</releaseType>
   <releaseSource>CD</releaseSource>
   <releaseLanguage>English</releaseLanguage>
   <releaseYear>2010</releaseYear>
   <tracksCount>12</tracksCount>
   <totalSize>190980754</totalSize>
   <totalPrice>1.49</totalPrice>
   <addedDate>2010-11-06</addedDate>
   <releaseUrl>
    http://mp3caprice.com/release/beautiful-voices-050-ambiental-trance-mix--16547?pid=P_00101
   </releaseUrl>
   <releaseLargeCoverUrl>
    http://cvr.mp3caprice.com/covers/albums/016/547/230.jpg
   </releaseLargeCoverUrl>
   <releaseSmallCoverUrl>
    http://cvr.mp3caprice.com/covers/albums/016/547/90.jpg
   </releaseSmallCoverUrl>
  </release>
  ...
 </releases>
</apiResponse>
[Note]

To get list of releases corresponding to genre with id that equals to 62 in json format use url like

http://api.mp3caprice.com/1.0/release/bySeries/62.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.2.6. release/byAddedDate

Description

Gets paginated releases added within specified period.

Releases are already sorted by released year in descending mode.

Endpoint

http://api.mp3caprice.com/1.0/release/byAddedDate/{pageSize}/{pageNumber}/{startDate}/{endDate}

Method Parameters

pageSize

positive integer value; specifies the page size to be returned. Maximum allowed value is 50.

pageNumber

positive integer value; specifies the page number to be returned.

startDate

date value in ISO format (yyyy-MM-dd). Specifies the start day of the period, inclusive.

endDate

date value in ISO format (yyyy-MM-dd). Specifies the end day of the period, inclusive.

Result Structure

Table API Methods.7. Releases by period result structure

Attribute Type Required Details
startDate Date yes Specified start date of the period, inclusive
endDate Date yes Specified end date of the period, inclusive
paginator Paginator yes Paginated releases corresponding to specified genre.

or Error

Result sorting order

Paginated release structures ordered by:

  • release.addedDate - DESC

  • release.releaseYear - DESC

  • release.releaseName

Method Example

Example API Methods.12. Get the first page of releases that were added during the year 2010.

http://api.mp3caprice.com/1.0/release/byAddedDate/10/1/2010-01-01/2010-12-31.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <startDate>2010-01-01</startDate>
 <endDate>2010-12-31</endDate>
 <paginator>
  <pageNumber>1</pageNumber>
  <pageSize>10</pageSize>
  <pageCount>1240</pageCount>
  <pageItems>
   <item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="release">
    <releaseId>17904</releaseId>
    <releaseName>Have Guitar Will Tour</releaseName>
    <artistId>10844</artistId>
    <artistName>Bo Diddley</artistName>
    <releaseType>Artist_Compilation</releaseType>
    <releaseSource>CD</releaseSource>
    <releaseLanguage>English</releaseLanguage>
    <releaseYear>2010</releaseYear>
    <tracksCount>33</tracksCount>
    <totalSize>267802184</totalSize>
    <totalPrice>4.01</totalPrice>
    <addedDate>2010-11-27</addedDate>
    <releaseUrl>
     http://mp3caprice.com/release/have-guitar-will-tour-17904?pid=P_00101
    </releaseUrl>
    <releaseLargeCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/017/904/230.jpg
    </releaseLargeCoverUrl>
    <releaseSmallCoverUrl>
     http://cvr.mp3caprice.com/covers/albums/017/904/90.jpg
    </releaseSmallCoverUrl>
   </item>
   ...
  </pageItems>
 </paginator>
</apiResponse>
[Note]

To get the first page of releases that were added during the year 2010 in json format use url like

http://api.mp3caprice.com/1.0/release/byAddedDate/10/1/2010-01-01/2010-12-31.json?api_key={API Key}&sub_account={sub_account}