XML input documents

The XML input document is passed as input to common SQL API stored procedures and adheres to a single, common document type definition (DTD).

The XML input document consists of a set of entries that are common to all stored procedures, and a set of entries that are specific to each stored procedure. The XML input document has the following general structure:

<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0"> 
<dict> 
   <key>Document Type Name</key><string>Data Server Message Input</string>
   <key>Document Type Major Version</key><integer>1</integer>
   <key>Document Type Minor Version</key><integer>0</integer>
   <key>Document Locale</key><string>en_US</string>
   <key>Complete</key><false/> 
      <!-- Document type specific data appears here. --> 
</dict>
</plist>

The Document Type Name key varies depending on the stored procedure. This example shows an XML input document for the GET_MESSAGE stored procedure. In addition, the values of the Document Type Major Version and Document Type Minor Version keys depend on the values that you specified in the major_version and minor_version parameters for the stored procedure.

If the stored procedure is not running in Complete mode, you must specify the Document Type Name key, the required parameters, and any optional parameters that you want to specify. Specifying the Document Type Major Version and Document Type Minor Version keys are optional. If you specify the Document Type Major Version and Document Type Minor Version keys, the values must be the same as the values that you specified in the major_version and minor_version parameters. You must either specify both or omit both of the Document Type Major Version and Document Type Minor Version keys. Specifying the Document Locale key is optional. If you specify the Document Locale key, the value is ignored.

Important: XML input documents must be encoded in UTF-8 and contain only English characters.