partner10.getProductConfigurations

Purpose

Gets the list of product configurations available for a client.

Signature

Method name: partner10.getProductConfigurations

Parameters (option 1)

#	Type	Description
1	struct AuthInfo	client authentication information
2	string	ID of a client

Parameters (option 2)

#	Type	Description
1	struct AuthInfo	client authentication information
2	string	ID of a client
3	boolean	look up for only enabled (true) or disabled (false)

Returns

Field	Type	Description
resultCode	int	code for command execution result (see below)
resultDesc	string	textual description of command execution result (see below)
productConfigurations	array(product configuration struct)	product configuration structs (see below)

Product Configuration Structure

Field	Type	Description
id	string	id of product configuration (unique throughout the system)
name	string	name of product configuration (unique for client)
enabled	boolean	whether it is enabled (true) or not (false)

Result Codes

resultCode	resultDesc
100	<number> of product configuration were found
200	Client authorization failed
201	Access to this method is denied
202	Access to this object is denied
250	A client with the login <id> is not found
252	This customer account is detected as problem. No further actions for this customer are allowed.
253	This customer account is unconfirmed. No further actions for this customer are allowed.

XML Examples

Request message

<?xml version='1.0'?>
<methodCall>
   <methodName>partner10.getProductConfigurations</methodName>
   <params>
      <param>
         <value>
           <struct>
              <member>
                 <name>login</name>
                 <value>
                    <string>LOGIN</string>
                 </value>
              </member>
              <member>
                 <name>password</name>
                 <value>
                    <string>PASSWORD</string>
                 </value>
              </member>
           </struct>
         </value>
      </param>
      <param>
         <value>
            <string>CLIENTID</string>
        </value>
      </param>
   </params>
</methodCall>

Response message

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
   <params>
      <param>
        <value><struct>
          <member>
            <name>resultCode</name>
            <value><int>100</int></value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>Found 2 product configurations</value>
          </member>
          <member>
            <name>productConfigurations</name>
            <value><array><data>
              <value><struct>
                <member>
                  <name>id</name>
                  <value>123</value>
                </member>
                <member>
                  <name>enabled</name>
                  <value><boolean>1</boolean></value>
                </member>
                <member>
                  <name>name</name>
                  <value>Default Plesk Configuration</value>
               </member>
              </struct></value>
              <value><struct>
                 <member>
                  <name>id</name>
                  <value>124</value>
                </member>
                <member>
                  <name>enabled</name>
                  <value><boolean>0</boolean></value>
                </member>
                <member>
                  <name>name</name>
                  <value>Test Configuration</value>
                </member>
              </struct></value>
            </data></array></value>
          </member>
        </struct></value>
      </param>
   </params>
</methodResponse>