API Methods.4. Series Methods

API Methods.4.1. series/root
API Methods.4.2. series/byId

API Methods.4.1. series/root

Description

Gets Mp3Caprice root series collection. (No sub series included).

Endpoint

http://api.mp3caprice.com/1.0/series/root

Method Parameters

No parameters.

Result Structure

Table API Methods.10. Series root result structure

Attribute Type Required Details
totalCount integer yes The total number of root series.
rootSeries List of Series yes Root series list without sub series.

or Error

Result sorting order

List of series structures ordered by:

  • seriesName

Possible Errors

Common Errors

Method Example

Example API Methods.16. Get root series

http://api.mp3caprice.com/1.0/series/root.xml?api_key={API Key}&sub_account={sub_account}
                  

<apiResponse>
 <totalCount>39</totalCount>
 <rootSeries>
  <series>
   <seriesId>65</seriesId>
   <seriesName>100% Hits</seriesName>
   <seriesUrl>
    http://mp3caprice.com/series/100-hits-65?pid=P_00101
   </seriesUrl>
  </series>
  ...
 </rootSeries>
</apiResponse>
[Note]

To get root series in json format use url like

http://api.mp3caprice.com/1.0/series/root.json?api_key={API Key}&sub_account={sub_account}
                  

API Methods.4.2. series/byId

Description

Get series by id

Endpoint

http://api.mp3caprice.com/1.0/series/byId/{seriesId}

Method Parameters

seriesId

positive integer value; specifies the series's id.

Result Structure

Series or Error

Result sorting order

Single series structure returned

Method Example

Example API Methods.17. Get series by id

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

<apiResponse>
 <seriesId>39</seriesId>
 <seriesName>Deeper</seriesName>
 <seriesUrl>
  http://mp3caprice.com/series/deeper-39?pid=P_00101
 </seriesUrl>
 <parentSeriesId>12</parentSeriesId>
 <parentSeriesName>Hed Kandi</parentSeriesName>
</apiResponse>
[Note]

To get series by id in json format use url like

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