getCategoryList

Returns a list of all available defined library categories in the active database.

Sample Request

<mmRequest command="getCategoryList" station="ID" [version="1"] [client=""] [userData=""] />

Request Notes

None

Sample Reply

<mmReply command="getCategoryList" station="ID" version="1" [userData=""] status="ok">
	<contents>
		<categories>
			<category id="1" code="H" nonmx="0" name="Heart" backcolor="255" forecolor="16777215"/>
			<category id="2" code="S" nonmx="0" name="Soul" backcolor="16711782" forecolor="16777215"/>
			<category id="3" code="N" nonmx="0" name="Novelty" backcolor="65535" forecolor="1"/>
			<category id="4" code="F" nonmx="0" name="Fringe" backcolor="65280" forecolor="1"/>
			<category id="5" code="E" nonmx="0" name="Beatles" backcolor="52479" forecolor="1"/>
			<category id="6" code="K" nonmx="0" name="Kickoffs" backcolor="13434624" forecolor="1118481"/>
			<category id="7" code="J" nonmx="1" name="Jingles" backcolor="11184810" forecolor="1"/>
			<category id="8" code="P" nonmx="1" name="Promos" backcolor="3355443" forecolor="16777215"/>
		</categories>
	</contents>
</mmReply>

Reply Notes

The list of categories is returned in the contents/categories section. Each category has a category tag. The following attributes are available for each defined category:

KEY	DESCRIPTION
id	Internal MusicMaster category ID code
code	User category code (3 chars max)
name	User category descriptive name
nonmx	Identifies the category type: 0=Music category 1=Non-Music category
backcolor	Background display color
forecolor	Foreground display color

Compatibility and Version Info

Available in all versions