SDK envelope request

The

AtHoc

SDK envelope is used to wrap SDK requests posted to the SDK listener. The following envelope format is required:

<AtHocSdk>
 <client>client id</client>
 <validation>
 <username>username</username>
 <password>password</password>
 </validation>
 <payload type=”type” trackId=”track-id”>
…
 </payload>
 <payload type=”type” trackId=”track-id”>
…
 </payload>
…
</AtHocSdk>

CDATA can be used to escape special characters in names. For example: <tag><|[CDATA( any text here
)]></tag>

Envelope format

Element	Definition
<AtHocSdk>	The root node of the XML document
<client>	The organization ID number for which SDK requests are made
<validation>	Validation is required to ensure that data is from a valid source. The username and password specified in the XML should be a valid Management System user who has been assigned the SDK role. Usually a “service account” is generated solely to perform SDK requests. Note that both the username and password are case-sensitive. If authenticity validation fails, the data will not be accepted by the BlackBerry AtHoc system. For other types of validation, see Manage API Access and Security.
<payload>	This is a wrapper for a single SDK request. The actual SDK request is enclosed in this node. type attribute specifies the type of SDK request trackId optional attribute can be used to identify the SDK request and is returned in the response XML document Multiple payloads can be included in one SDK envelope and are processed serially.

The following is a sample envelope format payload:

<AtHocSdk>
<client>2050704</client>
<validation>
<username>USERNAME</username>
 <password>PASSWORD</password>
 </validation>
 <payload type=”INFOCASTING”>
<infocasting>
    <alertData>
    <scenario id="12345" />
</alertData>
</infocasting>
</payload>
</AtHocSdk>

Section:

Using the BlackBerry AtHoc SDK APIs