Predictive Search

Returns suggestions for terms entered. 

We look for suggestions in each of the following areas:

1. tracks
2. albums
3. styles
4. member tags
5. categories
6. labels
7. rightholders
8. lyrics


Fields being searched can also be customised.

1. track (fields available: `displaytitle, keywords, alternatetitle`; default is just `displaytitle`)
2. albums (fields available: `cdcode, displaytitle, description`; default is `cdcode, displaytitle`)
3. styles (default: `name, keywords`; no options)
4. member tags (default: `tag name, keywords`; no options)
5. categories (default: `category attribute name`; no options)
6. labels (fields available: `title, prefix, description`; default is `title`)
7. rightholders (see details below)
8. lyrics (default is `track lyrics`; no options)

Keyword groups (synonyms) can also be applied to the fields being searched.

Right Holder Types
In the request rightholdertypes is string of right holder types with comma separation. Options include: 

  • Author
  • Composer
  • ComposerAuthor
  • Arranger
  • Publisher
  • SubPublisher
  • Artist 

Return Right Holders Fields - In the request returnrightholders_fields is string of right holder fields with comma separation. Options include:

  • FirstName
  • LastName
  • Name  (use this for Publisher & SubPublisher)
  • MiddelName
  • IPI

 

Request
POST /autocomplete/{serviceToken}

Parameter Type Status
ServiceToken String Mandatory
Request Body XML Mandatory

Request body

<requestautocomplete>


<regionid>3a6zzzzzzzzzzzz8b</regionid>
<memberaccountid>207zzzzzzzzzzdd</memberaccountid>
<keyword>pop</keyword>
<wildcard>true</wildcard>

<returntracks>true</returntracks>
<returntracks_mainonly>true</returntracks_mainonly>
<returntracks_limit>5</returntracks_limit>
<returntracks_order></returntracks_order>
<returntracks_rank></returntracks_rank>
<returntracks_fields>DisplayTitle,Keywords,AlternateTitle</returntracks_fields>
<searchfilters></searchfilters>
<returntracks_disablekeywordgroup>false</returntracks_disablekeywordgroup>

<returnalbums>true</returnalbums>
<returnalbums_limit>5</returnalbums_limit>
<returnalbums_order></returnalbums_order>
<returnalbums_fields>CdCode,DisplayTitle,Description,Keywords</returnalbums_fields>
<returnalbums_disablekeywordgroup>false</returnalbums_disablekeywordgroup>

<returnstyles>true</returnstyles>
<returnstyles_limit>5</returnstyles_limit>
<returnstyles_order></returnstyles_order>
<returnstyles_disablekeywordgroup>false</returnstyles_disablekeywordgroup>

<returntags>true</returntags>
<returntags_limit>5</returntags_limit>
<returntags_disablekeywordgroup>false</returntags_disablekeywordgroup>

<returncategoryattributes>true</returncategoryattributes>
<returncategoryattributes_limit>5</returncategoryattributes_limit>
<returncategoryattributes_showonplayeronly>false</returncategoryattributes_showonplayeronly>
<returncategoryattributes_includecategory>false</returncategoryattributes_includecategory>
<returncategoryattributes_order>AllAlphabetic</returncategoryattributes_order>
<returncategoryattributes_disablekeywordgroup>false</returncategoryattributes_disablekeywordgroup>

<categoryattributesearches>
 <categoryattributesearch>
  <categories>01dddddddddddde9</categories>
  <limit>10</limit>
  <showonplayeronly>false</showonplayeronly>
  <includecategory>false</includecategory>
  <fields>CategoryAttributeName,CategoryAttributeKeywords</fields>
  <order>AllAlphabetic</order>
  <disablekeywordgroup>false</disablekeywordgroup>
 </categoryattributesearch>
</categoryattributesearches>

<returnlibraries>true</returnlibraries>
<returnlibraries_limit>5</returnlibraries_limit>
<returnlibraries_fields>Name,Prefix,Description</returnlibraries_fields>
<returnlibraries_disablekeywordgroup>false</returnlibraries_disablekeywordgroup>

<returnrightholders>true</returnrightholders>
<rightholdertypes>Artist</rightholdertypes>
<returnrightholders_limit>5</returnrightholders_limit>
<returnrightholders_fields>firstname, lastname</returnrightholders_fields> 
<returnrightholders_disablekeywordgroup>false</returnrightholders_disablekeywordgroup>

<returnlyrics>true</returnlyrics>
<returnlyrics_limit>5</returnlyrics_limit>
<returnlyrics_mainonly>false</returnlyrics_mainonly>
<returnlyrics_disablekeywordgroup>false</returnlyrics_disablekeywordgroup>

</requestautocomplete>

 

The following are mandatory 
regionid  
keyword  
   
categories  If the <categoryattributesearches> element is included
   

  

Fields
albums CdCode,DisplayTitle,Description,Keywords
tracks DisplayTitle,AlternateTitle.Keywords
categories CategoryAttributeName,CategoryAttributeKeywords
labels Name,Prefix,Description
rightholders FirstName,LastName,Name,MiddelName,IPI

Note Name is used for publishers only.

 

Ordering
albums Date_Ascent,Date_Descent,Alphabetic_Ascent,Alphabetic_Descent
styles Alphabetic_Ascent,Alphabetic_Descent
tracks Date_Ascent,Date_Descent,Alphabetic_Ascent,Alphabetic_Descent

RankExpression is also available and needs an extra element <returntracks_rank> in the request.
categories AllAlphabetic,CategoryOrderAlphabetic
   

 

NOTE:
- Only active track elements are returned within Response object.

Successful Response

<responseautocomplete albumsfound="581" tracksfound="443" stylesfound="1" tagsfound="1" categoryattributesfound="1" librariesfound="1" composersfound="16">

<autocomplete_albums>
<autocomplete_album id="8adxxxxxxxxe2f0" code="24s082" displaytitle="24s082 Drama:Pop 01" trackcount="81"/>
</autocomplete_albums>

<autocomplete_tracks>
<autocomplete_track id="5dfbxxxxxxxx5a3" code="4EM018" tracknumber="033" displaytitle="Access Pop - w/ Top Sweep"/>
</autocomplete_tracks>

<autocomplete_styles>
<autocomplete_style id="5c4xxxxxxxx347" name="Pop" albumcount="471"/>  </autocomplete_styles>

<autocomplete_tags>
<autocomplete_tag id="2a0fxxxxxxxx66" name="pop" trackcount="0"/>
</autocomplete_tags>

<autocomplete_categoryattributes>
<autocomplete_categoryattribute id="15xxxxxxxxb9" name="pop" categoryid="0153899abfd21ee9" categoryname="test"/>
</autocomplete_categoryattributes>

<autocomplete_categoryattributeresults>
<autocomplete_categoryattributeresult categoryattributesfound="1">         
<categoryattributes>
<autocomplete_categoryattribute id="1xxxxxxxxb9" name="pop" categoryid="0153899abfd21ee9" categoryname="test"/>
</categoryattributes>
</autocomplete_categoryattributeresult>
</autocomplete_categoryattributeresults>

<autocomplete_libraries>
<autocomplete_library id="aexxxxxxxxc" name="Pop Machine"/>
</autocomplete_libraries>
<autocomplete_rightholders>

<autocomplete_rightholder id="43c50000000007" firstname="John" lastname="Smith" name="" middelname="" ipi="422235"/>
</autocomplete_rightholders>

<autocomplete_lyrics>
<autocomplete_lyric id="9bxxxxxxxx82" lyric="Because this crazy love I feel for you  It is so strong and is so true"/>
</autocomplete_lyrics>

</responseautocomplete>

Error Response:

<responseautocomplete>
<error>
<code>5</code>
<description>Invalid Token</description>
</error>
</responseautocomplete>

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.