Previous page

Next page

Locate page in Contents

Print this page

XML Message Specifications

The XML message specifications in the Agent documentation are described using tables, similar to the following example:

Name

Min/Max

Type

Description

login

 

 

 

{

 

 

 

  name

1..1

base64Binary

User name.

  domain

0..1

base64Binary

Domain.

  realm

1..1

guid_type

Realm ID.

  password

1..1

base64Binary

User password.

  expiration

0..1

int

Custom timeout value.

}

 

 

 

The information in a table is based on a corresponding XML Schema and describes the format of a request or response message, or the format of a data type.

Each row in a table represents an XML element. The elements are displayed in the order they are defined in the XML Schema.

The definitions for the table columns are as follows:

Name. Specifies an XML element name. The curly brackets represent the standard XML Schema xs:sequence element. This means that the elements inside the brackets are the child elements of the element that precedes the opening bracket. In our example, the name, domain, realm, password, and expiration elements are children of the login element. The following is a sample XML code, built according to this specification:

<login>

  <name>bXluYW1l</name>

  <domain>bXlkb21haW4=</domain>

  <realm>bXlyZWFsbQ==</realm>

  <password>bXlwYXNz</password>

  <expiration>1000</expiration>

</login>

Min/Max. Specifies the cardinality of an element (the number of its minimum and maximum occurrences) in the following format:

minOccurs..maxOccurs

0 in the first position indicates that the element is optional.

1 in the first position indicates that the element is mandatory and that it must occur at least once.

A number in the second position indicates the maximum allowable number of occurrences. The [] (square brackets) in the second position indicate that the maximum number of the element occurrences is unbounded, meaning that the element may occur as many times as necessary in the same XML document at the specified position.

Type. Specifies the element type. The following element types are used in the schema:

Description. The description column contains the element description and provides the information about its usage.

Please send us your feedback on this help page