Overview
Skill Level: Any
Prerequisites
This interface returns the specified Ruleset in XML format. It does not support returning content images. To retrieve a complete Ruleset and its associated content, use the ExportDCRuleset operation.
Step-by-step
-
Syntax of the request and response SOAP for GetDCRuleset
Operation <GetDCRuleset> Elements RULESET_ID The ID of the Ruleset to retrieve. Example <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:GetDCRuleset>
<user:RULESET_ID>550802</user:RULESET_ID>
</user:GetDCRuleset>
</soapenv:Body>
</soapenv:Envelope>Response <RESULT> Elements SUCCESS “True” indicates a successful “Get Ruleset” call.
“False” indicates an error occurred in which the error code displays with a
message reporting the issue.RULESET Child Elements RULESET_ID The ID of the requested Ruleset. RULESET_NAME The name of the Ruleset. CONTENT_AREAS See AddDCRuleset for details RULES See AddDCRuleset for details Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<RULESET>
<RULESET_ID>550802</RULESET_ID>
<RULESET_NAME>Locale Body Ruleset ‐ Import</RULESET_NAME>
<CONTENT_AREAS>
<CONTENT_AREA name=”MAILING BODY” type=”Body‐
HTML”>
<DEFAULT_CONTENT name=”Default.MAILING
BODY”><p>This is the content for people whose Locale is unknown….</p><p><img
src=”http://domain.com/images/question_mark.jpg” name=”question.jpg” spname=”question.jpg” alt=””
width=”97″ border=”0″ height=”145″></p></DEFAULT_CONTENT>
</CONTENT_AREA>
</CONTENT_AREAS>
<RULES>
<RULE>
<RULE_NAME>US ENGLISH</RULE_NAME>
<PRIORITY>1</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>US ENGLISH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”US_ENGLISH.MAILING
BODY” content_area=”MAILING BODY”><p>This is the US English Newsletter.</p><p><img
style=”border: 1px solid ;” src=”http://domain.com/images/us_flag.jpg” name=”usa.jpg” spname=”usa.jpg”
alt=”” width=”127″ height=”90″></p></CONTENT>
</CONTENTS>
</RULE>
<RULE>
<RULE_NAME>UK_ENGLISH</RULE_NAME>
<PRIORITY>2</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>UK ENGLISH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”UK_ENGLISH.MAILING
BODY” content_area=”MAILING BODY”><p>This is the UK English Content.</p><p><img
src=”http://domain.com/images/uk_flag.jpg” spname=”ukflag.jpg” alt=”” width=”143″ border=”0″
height=”107″></p></CONTENT>
</CONTENTS>
</RULE>
<RULE>
<RULE_NAME>CAN_FRENCH</RULE_NAME>
<PRIORITY>3</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>CAN FRENCH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”CAN_FRENCH.MAILING
BODY” content_area=”MAILING BODY”><![CDATA[<p>This is the French Canadian content.</p><p><img
style=”border: 1px solid ;” src=”http://domain.com/images/can_french.jpg” name=”can.jpg”
spname=”can.jpg” alt=”” width=”141″ height=”106″></a></p>]]></CONTENT>
</CONTENTS>
</RULE>
</RULES>
</RULESET>
</RESULT>
</envelope:Body>
</envelope:Envelope>