Get alert template

Retrieve Details of an alert template.

The payload type is GET-SCENARIO.

The payload content should be in the following format:

<scenario commonName="scenarioCommonName" id="scenario Id" />

GET-SCENARIO SDK requests and responses are internationalization-enabled. For a list of supported Windows 1252 characters, see Internationalization-supported characters.

<SCENARIO> Nodes

Tag	Mandatory	Description
<scenario>	Yes	Attributes—Either commonName or ID is required. commonName —The alert template common name. id —The alert template ID.

The SDK response is:

<scenarioResponse>
<scenario id="scenario id">
<name>scenario name</name>
<commonName></commonName>
<availableInHomePage></availableInHomePage>
<availableForMobile></availableForMobile>
<createdBy></createdBy>
<createdOn></createdOn>
<updatedBy></updatedBy>
<updatedOn></updatedOn>
<channel id="channel id">
<name></name>
<commonName></commonName>
</channel>
</scenario>
<userData type="USR|IP" targetAll="Y|N">
<groupCommonName>group common name</groupCommonName>
<groupCommonName isBlocked="Y" isGroupSet="N">group common name</groupCommonName>
<groupCommonName isBlocked="N" isGroupSet="Y">groupset common name</groupCommonName>
… …
<hierarchyLocation commonname="Organizational Hierarchy|Dist Lists|IP Lists" >
<path isBlocked="Y|N">/Node1/Node12/Node121/</path>
<path isBlocked="Y|N">/Node2/</path>
…
</hierarchyLocation>
<distributionList commonname="List-A" name="List A" type="STATIC|DYNAMIC|IP" isBlocked="N|Y" />
…
<attributeCondition id="UserAttributeId" name="AttributeName" commonname="AttributeCommonName" >
<condition>EQUALS | NOT EQUALS | CONTAIN | DOES NOT CONTAIN | STARTS WITH | ENDS WITH | LESS THAN | GREATER THAN | LESS THAN EQUAL | GREATER THAN EQUAL | />
<searchValues>
<value commonname="Burlingame">94010</value>
<value>94040</value>
…
</searchValues>
</attributeCondition>
…
<deviceCondition commonName="workEmail" id="2">
<condition>EQUALS</condition>
<searchValues>
<value>jsmith@acme.com</value>
</searchValues>
</deviceCondition>
</userData >
<alertData>
<title>alert title</title>
<header>alert header</header>
<body>alert body</body>
<url>url to use when clicking on alert</url>
<notifierTemplate>desktop popup template id</notifierTemplate>
<messagePriority>1</messagePriority>
<overrideUserDeliveryPrefs>Y|N</overrideUserDeliveryPrefs>
<type>Security</type>
<severity>High</severity>
<deliverySettings type="SYS|OPR|USR">
<devices>
<device commonname="DesktopPopup" targeted="Y|N" />
<device commonname="phoneWork" deliveryPriority="2" targeted="Y|N" />
…
</devices>
</deliverySettings>
<responseOptions>
<responseOption>
<responseText>I am OK</responseText>
</responseOption>
<responseOption>
<responseText>I am not OK</responseText>
</responseOption>
</responseOptions>
<metaStore>alert meta store</metaStore
<advancedDeliverySettings>
<AlertExtensions>
<AlertExtension CommonName="Extension Common Name">
<data>
     <element id="AlertExtension id"></element>
…
</data>
</AlertExtension>
</AlertExtensions>
</advancedDeliverySettings>
</alertData>
<placeHolders>
<placeHolder>
<name>Place Holder name</name>
<value>Place Holder default value, if supplied</value>
</placeHolder>
…
</placeHolders>
</scenarioResponse>

Get alert template – session ID

Return the alert templates associated with a specific session ID that is generated for an authorized Personal Safety Service Operator using a mobile device.

<AtHocSdk>
<client>2035387</client>
<validation>
<sessionId>6727aea1-b862-4370-a5df-9ea98e90d00c</sessionId>
</validation>
<payload type="GET-SCENARIO">
<scenarios>
<readyForPublish>Y</readyForPublish>
</scenarios>
</payload>
</AtHocSdk>

The example of the SDK payload response will be:

<AtHocSdkResponse>
   <payload type="GET-SCENARIO" trackId="">
   <ok>
      <systemDate>2012-09-26T21:24:31.9494014Z</systemDate>
      <responsePayload>
        <scenarioResponse>
 <scenario id="10212">
               <commonName>All Clear</commonName>
               <availableInHomePage>Y</availableInHomePage>
               <availableForMobile>Y</availableForMobile>
               <readyForPublish>Y</readyForPublish>
               <createdBy>first AthoC Young test</createdBy>
               <createdOn>2012-09-13T09:42:03.6</createdOn>
               <updatedBy>Sherill FB</updatedBy>
               <updatedOn>2012-09-25T15:00:11.867</updatedOn>
               <channel id="210980"> 
                 <name>System Default</name>
                 <commonName>SYSTEM-DEFAULT</commonName>
               </channel>
            </scenario>
            <userData type="USR" targetAll="N">
               <mid isBlocked="N">ATHOC\sfletch</mid>
            </userData>
            <alertData>
               <action>PUBLISH</action>
               <header>All Clear</header>
               <body>This is a test All Clear Alert</body>
               <url />
               <notifierTemplate>Default Template</notifierTemplate>
               <audioId>BlankAudio</audioId>
               <localeCode>en-US</localeCode>
               <messagePriority>1</messagePriority>
               <deliverySettings type="USR">
                  <device commonname="DesktopPopup" deliveryPriority="0" />
             </deliverySettings>
               <advancedDeliverySettings>
                  <AlertExtensions />
               </advancedDeliverySettings>
               <liveDate>2012-09-27T01:24:30</liveDate>
               <endDate>2012-09-27T01:24:30</endDate>
               <UTCtimestamp>Y</UTCtimestamp>
               <responseOptions />
               <consolidateMessages>N</consolidateMessages>
               <overrideUserDeliveryPrefs>N</overrideUserDeliveryPrefs>
            </alertData>
        </scenarioResponse>
      </responsePayload>
      <warnings />
   </ok>
   </payload>
</AtHocSdkResponse>

Get alert template – session ID and alert template common name

Return the alert template associated with a specific session ID and the alert template common name that is generated for an authorized Personal Safety Service Operator using a mobile device.

<AtHocSdk>
<client>2035387</client>
<validation>
<sessionId>6727aea1-b862-4370-a5df-9ea98e90d00c</sessionId>
</validation>
<payload type="GET-SCENARIOS">
<scenario id=’8331’>
<readyForPublish>Y</readyForPublish>
</scenarios>
 </payload>
</AtHocSdk>

Get alert template – access token and alert template common name

Return the alert template associated with a specific access token and the alert template common name that is generated for an authorized Personal Safety Service Operator using a mobile device.

<AtHocSdk>
<client>2035387</client>
<validation>
<accessToken>6727aea1-b862-4370-a5df-9ea98e90d00c</accessToken>
</validation>
<payload type="GET-SCENARIOS">
<scenario id=’8331’>
<readyForPublish>Y</readyForPublish>
</scenarios>
 </payload>
</AtHocSdk>

Section:

Content APIs