Get the PDF

SDK envelope response

If no error occurs, there is a payload response node for every sent payload. The payload is identified by type and trackId (if provided):

<AtHocSdkResponse>    
<payload type=”type” trackId=”track-id”>    
<ok>        
<systemDate>utc time of server</systemDate>
<responsePayload>
…
</responsePayload>    
<warnings>
<warning>
<id>warning id</id>
<description>warning description</description>
<moreData>some more info</moreData>            
</warning>        
</warnings>
</ok>
</payload>
<payload type=”type” trackId=”track-id”>
<error>
<systemDate>time of server</systemDate>
<id>error id</id>
<description>error description</description>
<moreData>more data regarding the error</moreData>
</error>
</payload>
…
</AtHocSdkResponse>

contains the data returned from the request, if any. For example, user synchronization returns the appropriate

and

inside the

node. Other requests, which do not return data, return an empty

<responsePayload>.

For example:

<AtHocSdkResponse>
<payload type=”GROUP-SETS” trackId=”GRO1238766”>
<ok>
<systemDate>2012-02-07T19:53:09.0524618Z</systemDate>
<responsePayload/>
</ok>
</payload>
<payload type=”INFOCASTING” trackId=”20133455”>
<error>
<systemDate>2012-02-07T19:53:09.0524618Z</systemDate>
<id>1002</id>
<description>Invalid Date</description>
</error>
</payload>
</AtHocSdkResponse>

If an error occurs while parsing the SDK request XML document, the following response will be returned:

<AtHocSdkResponse>
<error>
<systemDate>UTC time of server</systemDate>
<id>error id</id>
<description>error description</description>
<moreData>more data regarding the error</moreData>
</error>
</AtHocSdkResponse>

For example:

<AtHocSdkResponse>
<error>
<systemDate>2012-02-07T19:53:09.0524618Z</systemDate>
<id>1000</id>
<description>parsing error</description>
<moreData>invalid at the top level of the document. (line:1, position:1)</moreData>
</error>
</AtHocSdkResponse>

The following general error codes are defined:

Error Code	Message	Description
1000	Parsing error	The system was not able to parse the XML. Data regarding the exact line and exact XML error appear in the <moreData> node.
1001	Invalid login	Security data did not match the data in the system
1002	Invalid IP	Invalid Source IP
9998	No request	No XML was posted to SDK listener
9999	General error	Details appear in the <moreData> node

Section:

Using the BlackBerry AtHoc SDK APIs