getRules

This will return a list of rules assigned to the specified category that is similar to the Category Rule List function available in the Rule Tree Editor. This rule list is for review only. No changes to rules can be made via Nexus.

Sample Request

<mmRequest command="getRules" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
			<categories>
				<category [id="1"] [code="A"]/>
			</categories>
	</contents>
</mmRequest>

Request Notes

You must specify a list of one or more valid categories that you wish to see rules for. You can use the category ID or Code values as returned from the command.

Sample Reply

<mmReply command="getRules" station="ID" version="1" [userData=""] status="???????">
	<contents>
		<ruleList category="X" catId="1">
			<rule allCategories="True" folder="0" folderName="Unbreakable" description="Artist Keywords - Keyword Time Separation [fixed: 0:20]"/>
			<group allCategories="True" folder="0" folderName="Unbreakable" description="Rule Group (Gender) [Always Tested]">
				<rule allCategories="True" inGroup="True" folder="0" folderName="Unbreakable" description="Gender F-Female - Maximum in Sequence [1]"/>
			</group>
			<rule folder="0" folderName="Unbreakable" description="Artist Keywords - Keyword Adjusted Time Separation [75% - auto: 2:10 - By Cat]"/>
			<rule folder="0" folderName="Unbreakable" description="Minimum Rest [3:30]"/>
		</ruleList>
	</contents>
</mmReply>

Reply Notes

One ruleList section will be included for each category requested. This will include tags for each rule and rule group available for that category. This will include All Categories rules if appropriate. Built-in rules and scheduling goals are not included. The list will be in the same order as would be shown in the Category Rule List viewer in MusicMaster. Each rule tag indicates the rule folder level, an indication of whether the rule is in a group or not, and the text rule description as shown in the Rule Tree editor. The following tag attributes may be found here:

 

• allCategories – set to True is this was an All Categories rule. Not included for individual category rules.
• folder - rule folder level. 0 = Unbreakable
• folderName – the text name of the rule folder
• inGroup – set to True is this rule is in a rule group. Not included otherwise.
• description – text description of the rule or rule group

Compatibility and Version Info

Available with MusicMaster PRO 5.0sr3 and later [5001]