Message body contains the actual request or response parameters and data. The data
element is the root element of the message body tree. It is followed by the name of the interface that you would like to use, the name of the call, and the call parameters.
Note: There must be one and only one data
element in any given message.
The request message:
The following XML code example is a complete Agent request message. As you already know, the packet
element is the root element of every Agent message. The target
element specifies the name of the target operator. The message body begins with the data
element. The sessionm
element specifies the name of the interface. The available interfaces are documented in the Parallels Agent XML API Reference documentation. The login
element is the name of the call. The name
, realm
, and password
elements are the call parameters.
<packet version="4.0.0" id="2">
<target>sessionm</target>
<data>
<sessionm>
<login>
<name>cm9vdA==</name>
<realm>00000000-0000-0000-0000-000000000000</realm>
<password>bXlwYXNz</password>
</login>
</sessionm>
</data>
</packet>
The response message:
The following example demonstrates a complete response message. The body of the message begins with the data
element which is followed by the name of the interface that was used in the corresponding request message, and the return parameters.
<packet xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/types" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/sessionm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="8c46e52645t18berd40" time="2007-09-09T02:11:21+0000" priority="0" version="4.0.0">
<origin>sessionm</origin>
<target>vzclient69-4fce28dd-0cd3-1345-bb94-3192b940fb90</target>
<dst>
<director>gend</director>
</dst>
<data>
<sessionm>
<session_id>vzl.40000.4.4fce28dd-0cd3-13..</session_id>
<token xsi:type="ns2:tokenType">
<user>AQUAAAAAIAHdKM5P0wxFE7uUMZK5QPuQAAAAAA==</user>
<groups>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQAAAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQAQAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQCgAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQAgAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQAwAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQBAAAAA==</sid>
<sid>AQUAAAAAIADdKM5P0wxFE7uUMZK5QPuQBgAAAA==</sid>
<sid>AQUAAAAAIAHdKM5P0wxFE7uUMZK5QPuQAAAAAA==</sid>
</groups>
<deny_only_sids/>
<privileges/>
</token>
</sessionm>
</data>
<src>
<director>gend</director>
</src>
</packet>
The body of a response message may, in general, contain one of the following types of information:
<OK/>
element if the call doesn't return any data by definition. The <OK/>
means that the operation completed successfully.A complete XML Schema specification exists for every possible response of every Agent XML API call, and is described in the corresponding section of the Parallels Agent XML API Reference guide.