partner10.createClient

Purpose

Creates a Client account.

Signature

Method name: partner10.createClient

 

Parameters

# Type Description

1

struct AuthInfo

requesting party authentication information

2

struct ClientInfo

client registration information

 

Returns

Field Type Description

resultCode

int

code for command execution result (see below)

resultDesc

string

textual description of command execution result (see below)

clientId

string

identifier of created client

login

string

login for created client

password

string

password for created client

 

Used Structures

Structure ClientInfo is used to specify client registration parameters:

Field Type Description

login

string

max chars 32 - optional, will be generated if not specified in call parameters (optional)

password

string

max chars 32 - optional, will be generated if not specified in call parameters.(optional)

firstName

string

max chars 64

lastName

string

max chars 64

company

string

max chars 64

address

string

max chars 256

email

string

max chars 256

phone

string

max chars 128

fax

string

max chars 128 (optional)

city

string

max chars 64

zip

string

depends on zip code size and country, for non US countries any characters are allowed, max chars 16; see the note below

state

string

max chars 32

country

string

max chars 2; see the note below

language

string

max chars 2 (optional) - GUI language

email_language

string

max chars 2 (optional) - Email language

Note: If you choose USA as a country, only zip codes of the type XXXXX or XXXXX-XXXX are allowed, where X is a digit. For two-letter country codes, please refer to the Country Codes section in the Appendix. For two-letter U.S. and Canada state codes please refer to the States Codes in the Appendix.

 

Result Codes

resultCode resultDesc

100

New client login has been successfully created

200

Authorization failed

201

Access to this method is denied

251

Login already exists

300

Internal error, please try after some time

400

Incorrect authorization info format

431

Incorrect login format

432

Incorrect password format

433

Incorrect firstName format

434

Incorrect lastName format

435

Incorrect company format

436

Incorrect address format

437

Incorrect email format

438

Incorrect phone number format

439

Incorrect fax number format

440

Incorrect city format

441

Incorrect zip format

442

Incorrect state format

443

Incorrect country format

444

Incorrect language format

 

XML Examples

Request message

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>partner10.createClient</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>login</name>
            <value>
              <string><em>API_LOGIN</em></string>
            </value>
          </member>
          </struct>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>login</name>
            <value>
              <string><em>CLIENT_LOGIN</em></string>
            </value>
          </member>
          <member>
            <name>password</name>
            <value>
              <string><em>CLIENT_PASSWORD</em></string>
            </value>
          </member>
          <member>
            <name>firstName</name>
            <value>
              <string>John</string>
            </value>
          </member>
          <member>
            <name>lastName</name>
            <value>
              <string>Doe</string>
            </value>
          </member>
          <member>
            <name>company</name>
            <value>
              <string>Example, Inc.</string>
            </value>
          </member>
          <member>
            <name>email</name>
            <value>
              <string>jdoe@example.com</string>
            </value>
          </member>
          <member>
            <name>address</name>
            <value>
              <string>Examplestreet 22</string>
            </value>
          </member>
          <member>
            <name>phone</name>
            <value>
              <string>703 973 2323</string>
            </value>
          </member>
          <member>
            <name>fax</name>
            <value>
              <string>703 943 3434</string>
            </value>
          </member>
          <member>
            <name>city</name>
            <value>
              <string>Example City</string>
            </value>
          </member>
          <member>
            <name>state</name>
            <value>
              <string>Virginia</string>
            </value>
          </member>
          <member>
            <name>zip</name>
            <value>
              <string>20171</string>
            </value>
          </member>
          <member>
            <name>country</name>
            <value>
              <string>US</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

 

Response message

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>clientId</name>
            <value>1401588</value>
          </member>
          <member>
            <name>login</name>
            <value><em>JDOE_CLIENT_LOGIN</em></value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>100</int>
            </value>
          </member>
          <member>
            <name>password</name>
            <value><em>JDOE_CLIENT_PASSWORD</em></value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>New client <em>CLIENT_LOGIN</em> has been successfully created</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.