Tags

 

Get Tags

The following method should be used to get tags

GET /getmembertags/{memberToken}

Parameter Type Status
MemberToken String Mandatory

 Successful Response

<responsetags>
<tags>
<tag tagid="3280000888"tagname="test 1"/>
</tags>
</responsetags>

Error Response

<responsetags>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsetags>

 

 

Get Tag Tracks

This method should be used to get tag tracks.

GET /getmembertagtracks/{memberToken}/{tagID}

Parameter Type Status
MemberToken String Mandatory
tagID String Mandatory


Successful Response

<responsetags>
<tag tagid="af70000000012" tagname="htn tag 2">
<tracks>
<track mood="" musicfor="" tracknumber="002" time="02:22" lengthseconds="142" comment="Peaceful Ambient-Folk, gentle guitar, reflective, indulging"
composer="Citokid" publisher="Intervox Edition" name="Comfort" albumid="b05000000000"
libraryid="3a60000011"
id="6300000234"
keywords="relaxed , thoughtful , gentle , country, folk" lyrics="" displaytitle="Comfort" alternatetitle="" genre="Ambient, Chill"
tempo="medium-slow" instrumentation="" bpm="81" mixout="" frequency="0" bitrate="0"
dateingested="2018-07-13 11:53:55" version="Maintitle" status="active" cdcode="A4561"
albumname="ABC Album" libraryname="Lib Name"
filename="this_track.wav" alternatecount="0"/>
</tracks>
</tag>
</responsetags>

Error Response

<responsetags>
<tag>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</tag>
</responsetags>

 

Get Tags by Track

This method should be used to get tags for a track.

GET /getmembertagsbytrack/{memberToken}/{trackID}

Parameter Type Status
MemberToken String Mandatory
trackID String Mandatory


Successful Response

<responsetags>
<tags>
<tag tagid="b3800fc9d71a6abc" tagname="name"/>
</tags>
</responsetags>

Error Response

<responsetags>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsetags>

 

 

Add Track Tag

This method should be used to add a tag to a track. 

POST /addtrackmembertag/{memberToken}

Parameter Type Status
MemberToken String Mandatory
Request Body XML Mandatory

 

Request body

<tag trackid="03487f3cb07d6455" tagname="test api tag" />


Successful Response

<responsetags>
<tags>
<tag tagid="a4ae3a7517a9cd123" tagname="test api tag add"/>
</tags>
</responsetags>

 

Error Response

<responsetags>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsetags>

 

 

Update Tag

This method should be used to update a tag. 

POST /updatemembertag/{memberToken}?mergeifexist=true

Parameter Type Status
MemberToken String Mandatory
mergeifexist String Optional, default=false
Request Body XML Mandatory

 

Request body

If mergeifexist is set to false and an existing tag with the same tagname is found, an error will be thrown.

<requestupdatetag>
<tag tagid="a4ae3a7517a9cd20" tagname="test api tag update" />
</requestupdatetag>


Successful Response

***Please note that the tagid may change in the response if merging is required***

<responsetags>
<tags>
<tag tagid="a4ae3a7517a9cd123" tagname="test api tag add"/>
</tags>
</responsetags>

 

Error Response

<responsetags>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsetags>

 

 

Remove Track Tag

This method should be used to remove a tag from a track.

GET /removetrackmembertag/{memberToken}/{tagID}/{trackID}

Parameter Type Status
MemberToken String Mandatory
tagID String Mandatory
trackID String Mandatory


Successful Response

<responsecode>
<code>OK</code>
</responsecode>

Error Response

<responsecode>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsecode>

 

Remove Tag

This method should be used to remove a tag from all tracks.

GET /removemembertag/{memberToken}/{tagID}

Parameter Type Status
MemberToken String Mandatory
tagID String Mandatory


Successful Response

<responsecode>
<code>OK</code>
</responsecode>

Error Response

<responsecode>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsecode>

 

Remove All Tags

This method should be used to remove all tags from all tracks.

GET /removemembertags/{memberToken}

Parameter Type Status
MemberToken String Mandatory


Successful Response

<responsecode>
<code>OK</code>
</responsecode>

Error Response

<responsecode>
<error>
<code>{string}</code>
<description>{string}</description>
</error>
</responsecode>

 

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

Comments

Article is closed for comments.