Previous page

Next page

Locate page in Contents

Print this page

XML Message Examples

The following table contains an examples of a valid Agent request message:

XML element

Description

<packet version="4.0.0" id="2">

This is the root element of any message. The id attribute specifies the packet ID. The version attribute specifies the protocol version.

  <target>sessionm</target>

The target Agent operator that the request should be sent to for processing.

Note: When using the system operator, do not include the target element. The system operator is the only exception. All other operators require the target element.

  <data>

The data block contains the message body.

    <sessionm>

Every request begins with the name of the interface providing the desired functionality. The interface name is always the same as the name of the operator (see target element above).

      <login>

This is the name of the API call.

        <name>bXluYW1l</name>

This and the following elements are the API call parameters.

        <realm>00000000</realm>

Parameter.

        <password>bXlwYXNz</password>

Parameter.

      </login>

Closing tag.

    </sessionm>

Closing tag.

  </data>

Closing tag.

</packet>

Closing tag.

A response message may look similar to the following example:

XML element

Description

<packet id="2" time="2007-03-11T11:17:30+0000" priority="0" version="4.0.0">

The root element. The time attribute specifies the response date and time. The version attribute specifies the protocol version.

  <origin>sessionm</origin>

The name of the operator that processed the request and generated this response as a result.

  <target>vzclient1</target>

The client who sent the initial request message. This value is generated and used internally by Agent.

  <data>

The message body.

    <sessionm>

Just like a request message, every response message also begins with the name of the interface. The block that follows this element contains the returned data.

      <token>

Data.

        <user>AQUAAAAAIAFWKop...</user>

Data.

        <groups>

Data.

          <sid>AQUAAAAAIABWKop..</sid>

Data.

        </groups>

Closing tag.

      </token>

Closing tag.

    </sessionm>

Closing tag.

  </data>

Closing tag.

</packet>

Closing tag.

Please send us your feedback on this help page