Node gen_info (type domainGenInfoType)

Representation of gen_info in API RPC 1.4.2.0 and later versions

This node is used in the get response packets. It is defined by complex type domainGenInfoType (plesk_domain.xsd) and holds a collection of common domain settings.

Starting from API RPC 1.4.2.0, the gen_info node has got some changes as follows:

• The display_name node is now called name
• The name node was renamed into ascii-name

  

• The cr_date node is required. It holds the creation date of the specified domain. Data type: date. Format: YYYY-MM-DD.
• The name node is required. It holds the domain name displayed in Plesk GUI. Data type: string.
• The ascii-name node is required. It holds the domain name in ASCII format. Data type: string.
• The status node is required. It holds the current status of the specified domain. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 4 (under backup/restore) | 16 (disabled by Plesk Administrator) | 32 (disabled by Plesk reseller) |64 (disabled by Plesk client) | 256 (expired).
• The real_size node is required. It holds the actual size of the domain (in bytes). Data type: unsignedLong.
• The client_id node is required. It holds the identifier of a Plesk client who owns this domain account. Data type: integer. Is not supported since protocol version 1.6.0.0. Use owner-id node instead.
• The owner-id node is optional. It holds the ID of Plesk user who owns this domain account. Must be specified if the request is issued by Plesk Administrator or Resellers. Data type: integer. Supported since protocol version 1.6.0.0.
• The dns_ip_address node is optional. It holds the domain IP address shown in the DNS record. Data type: ip_address (common.xsd).
• The htype node is required. It specifies the type of hosting set on the domain. Data type: string. Allowed values: vrt_hst | std_fwd | frm_fwd | none.
• The guid node is required. It contains the domain account GUID. Data type: string. This node is supported in API RPC 1.5.2.0 and later versions. For details on GUIDs, refer to the GUIDs Overview section of the API RPC Developer's Guide.

The following packet with general domain information can be received from Plesk server if API RPC 1.4.2.0 is used:

<packet version="1.6.0.0">

<domain>

<get>

   <result>

      <status>ok</status>

      <filter-id>1234</filter-id>

      <id>1234</id>

      <data>

          <gen_info>

             <cr_date>2000-12-12</cr_date>

             <name>www.example.com</name>

             <ascii-name>www.example.com</ascii-name>

             <status>256</status>

             <real_size>54687742156789</real_size>

             <owner-id>111</owner-id>

             <dns_ip_address>196.0.2.123</dns_ip_address>

             <htype>vrt_hst</htype>

             <guid>aasdgr342dsaddw3r32rsdfsdf3t</guid>

          </gen_info>

      </data>

   </result>

</get>

</domain>

</packet>

This packet is specific for protocol version 1.4.2.0 and later: The response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain id, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature.

Representation of gen_info in API RPC 1.4.1.2 and earlier versions

In API RPC 1.4.1.2 and earlier, this node is structured as follows:

• The cr_date node is required. It holds the creation date of the specified domain. Data type: date. Format: YYYY-MM-DD.
• The name node is required. It holds the domain name. Data type: string.
• The display_name node is required. It holds the domain name displayed in Plesk GUI. Data type: string.
• The status node is required. It holds the current status of the specified domain. Data type: objectStatus (plesk_common.xsd). Allowed values: 0 (active) | 4 (under backup/restore) | 16 (disabled by Plesk Administrator) | 64 (disabled by Plesk client) | 256 (expired).
• The real_size node is required. It holds the actual size of the domain (in bytes). Data type: unsignedLong.
• The client_id node is required. It holds the identifier of Plesk client who owns this domain account. Data type: integer.
• The dns_ip_address node is optional. It holds the domain's IP address shown in the DNS record. Data type: ip_address (common.xsd).
• The htype node is required. It specifies the type of hosting set on the domain. Data type: string. Allowed values: vrt_hst | std_fwd | frm_fwd | none.

The following packet with general domain information can be received from Plesk server:

<packet version="1.4.1.2">

<domain>

<get>

   <result>

      <status>ok</status>

      <id>1234</id>

      <data>

          <gen_info>

             <cr_date>2000-12-12</cr_date>

             <name>alterzone.co.uk</name>

             <display_name>www.alterzone.co.uk</display_name>

             <status>256</status>

             <real_size>54687742156789</real_size>

             <client_id>111</client_id>

             <dns_ip_address>123.123.13.123</dns_ip_address>

             <htype>vrt_hst</htype>

          </gen_info>

      </data>

   </result>

</get>

</domain>

</packet>