Response Packet Structure

The get-db node of the output XML packet is presented by type DatabaseGetDBOutputType (database_output.xsd) and structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd).
• The status node is required. It specifies the execution status of the get-db operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the get-db operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the get-db operation fails. Data type: string.
• The filter-id node is optional. It returns the filtering rule parameter. For more information, refer to the Filtering Issues section.
• The name node is required. It specifies the database name. Data type: string.
• The type node is required. It specifies the database type. MySQL and MS SQL are available in Plesk for Windows. MySQL and PostgreSQL types are available in Plesk for Unix. Data type: string. Allowed values: mssql | mysql | postgresql.
• The domain-id node is optional. It is required if the get-db operation succeeds. It specifies the ID of the domain on which a database is added. Data type: integer.
• The db-server-id node is optional. It is required if the get-db operation succeeds. It specifies the ID of the database server on which a database will be created. This node is required only in Plesk for Unix. Data type: integer.
• The default-user-id node is optional. It is required if the get-db operation succeeds. It specifies ID of the database administrator. Data type: integer.