Type clientGetGenInfo

When getting the general customer account information, complex type clientGetGenInfo (plesk_client.xsd) is used in the response get packet. It is structured as follows (reduced version):

image-60602.png

  • The cr_date node is required. It specifies the date when the specified customer account was created. Data type: date.
  • The cname node is required. Specifies the company name. Data type: string (1 to 60 characters long).
  • The pname node is required. Specifies the personal name of the customer who owns the customer account. Data type: string (1 to 60 characters long).
  • The login node is required. Specifies the login name of the customer account. Data type: string (1 to 20 characters long).
  • The status node is required. Specifies the current status of the customer account. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 16 (disabled_by admin) | 4 (under backup/restore) | 256 (expired). Default value: 0.
  • The phone node is required. Specifies the phone number of the customer account owner. Data type: string (0 to 30 characters long).
  • The fax node is required. Specifies the fax number of the customer account owner. Data type: string (0 to 30 characters long).
  • The email node is required. Specifies the email address of the customer account owner. Data type: string (0 to 255 characters long).
  • The address node is required. Specifies the postal address of the customer account owner. Data type: string (0 to 255 characters long).
  • The city node is required. Specifies the city of the customer account owner. Data type: string (0 to 50 characters long).
  • The state node is required. Specifies the US state of the customer account owner (specified for US citizens only). Data type: string (0 to 50 characters long).
  • The pcode node is required. Specifies the zip code of the customer account owner (specified for US citizens only). Data type: string (0 to 10 characters long).
  • The country node is required. Specifies the 2-character country code of the customer account owner (US for United States, CA for Canada, etc.). Data type: string (2 characters long).
  • The locale node is required. Specifies the locale used on the customer account. Data type: string. Default value: en.

Note

The four-letter locale name is always returned.

  • The password_type node is optional. Specifies the type of the customer account password. Data type: string. Allowed values: crypt | plain.
  • The guid node is optional. It contains the customer GUID. For details on GUIDs, refer to the GUIDs Overview section of the API RPC Developer Guide. Data type: string.
  • The owner-id node is optional. It holds the identifier of the customer owner (reseller or Plesk administrator). Data type: integer.
  • The owner-login node is optional. It holds the Administrator username. The value is returned only for the admin user. Data type: string.
  • The vendor-guid node is optional. It holds the service provider for the customer (a reseller or the Administrator). Data type: string.
  • The external-id node is optional. It holds the customer GUID in the Panel components (for example, Business Manager). Data type: string.