getSongsByList

Returns a list of songs from a saved song list.

Sample Request

<mmRequest command="getSongsByList" station="Jill's Seminar Data" client="NexusTest 1.1" userData="hello">
	<contents>
		<songList id="1"/>
		<fields>
			<field id="12"/>
			<field name="Artist"/>
			<field name="Title"/>
		</fields>
	</contents>
</mmRequest>

Request Notes

The song list you wish to load is specified in the contents/songList tag. The id attribute is the MusicMaster ID number of the desired list. You can obtain a list of available saved song lists with the command.

 

The fields section must contain one field tag for each song field you wish to include in the reply message. You can use the id attribute with the internal field ID codes, or a name attribute with the user-specified field name. Only the specified fields will be returned for each song. However, the internal song ID number will always be included in the reply. You can obtain a list of available fields with the command.

 

Note that the fields section is optional. If not specified, only the song id, runtime and the primary and secondary fields will be returned. Typically, primary and secondary fields are defined as title and artist.

Sample Reply

<mmReply command="getSongsByList" version="1" messageId="743c127a-4132-4701-8de3-352b86a77fb2" userData="hello" status="ok">
  <contents>
    <songList recordCount="33">
      <song songId="7">
        <field id="12" name="RunTime">03:30</field>
        <field id="102" name="Artist">FAITH HILL</field>
        <field id="134" name="Title">THE WAY YOU LOVED ME</field>
      </song>
      <song songId="444">
        <field id="12" name="RunTime">04:30</field>
        <field id="102" name="Artist">JOSH GROBAN</field>
        <field id="134" name="Title">WHEN YOU SAY YOU LOVE ME</field>
      </song>
      <song songId="9">
        <field id="12" name="RunTime">04:39</field>
        <field id="102" name="Artist">BROWNSTONE</field>
        <field id="134" name="Title">GAME OF LOVE</field>
      </song>
      <song songId="15">
        <field id="12" name="RunTime">04:51</field>
        <field id="102" name="Artist">WILSON PHILIPS</field>
        <field id="134" name="Title">YOU'RE IN LOVE</field>
      ....
    </songList>
  </contents>
</mmReply>

Reply Notes

The list of songs is returned in the contents/songlist section. Each song has a song tag. The songid attribute contains the MusicMaster internal song ID for each song. One of more field tags may be included with the value of each requested field. Each field tag includes an id attribute with the internal field ID number and a name attribute with the user defined field name.

Compatibility and Version Info

Available in all versions