Retrieving the List of Reseller's Domains

Use the get-domain-list operation to retrieve information about reseller's domains, subdomains, and domain aliases.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving reseller domains includes the get-domain-list operation node:

<packet>
<reseller>
   <get-domain-list>
   ...
   </get-domain-list>
</reseller>
</packet>

 

The get-domain-list node has the following graphical representation:

get-domain-list

  • The filter node is required. It specifies reseller accounts whose domains are to be retrieved. Data type: ResellerSelectionFilter. To view the structure of this node, refer to the Available Filters section.

 

 

Response Packet Structure

The get-domain-list node of the response packet is structured as follows:

get-domain-lis_output

The result node wraps the response retrieved from the server. Data type: resultFilterType (common.xsd).

  • result, required. It wraps the response got from the server. Data type: resultFilterType (common.xsd).
  • status, required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
  • errcode, optional. It returns the error code when the operation fails. Data type: unsignedInt.
  • errtext, optional. It returns the error message if the operation fails. Data type: string.
  • filter-id, optional. It returns the parameter by which the reseller account was filtered by in the request packet. Data type: anySimple.
  • id, optional. It returns the identifier of the reseller account for which the applications filter was turned on. Data type: id_type (common.xsd).

The information about the domains is held by the domain node, which is presented by complex type domainListOutputType (domain_list.xsd). The node is structured as follows:

  • The id node is required. It holds the ID of the domain. Data type: id_type.
  • The name node is required. It holds the domain name. Data type: string.
  • The ascii-name node is required. It holds the domain name in ASCII characters. Data type: string.
  • The type node is required. It holds the domain type (domain, subdomain, alias). Data type: string.
  • The main node is required. It indicates whether the domain is the main domain on a webspace. Data type: boolean.
  • The guid node is required. It holds the unique identifier of the domain. Data type: string.
  • The external-id node is required. It holds the identifier of the domain in an external system. Data type: string.
  • The parent-id node is optional. It holds the ID of the parent domain to which the subdomain belongs. Data type: id_type.
  • The domain-id node is optional. It holds the ID of the domain to which the domain alias is related. Data type: id_type.

  

 

Samples

The following packet retrieves the list of reseller's domains:

<packet>
<reseller>
     <get-domain-list>
      <filter>
          <id>1</id>
      </filter>     
   </get-domain-list>
</reseller>
</packet>

Response:

<packet>
  <reseller>
     <get-domain-list>
      <result>
        <status>ok</status>
        <filter-id>32</filter-id>
        <id>32</id>
        <domains>
          <domain>
            <id>41</id>
            <name>ressub.com</name>
            <ascii-name>ressub.com</ascii-name>
            <type>domain</type>
            <main>true</main>
            <guid>91755d52-849a-45f9-8808-3fc35d913670</guid>
            <external-id/>
          </domain>
          <domain>
            <id>42</id>
            <name>sub1.ressub.com</name>
            <ascii-name>sub1.ressub.com</ascii-name>
            <type>subdomain</type>
            <main>false</main>
            <guid>605aa1d9-cddd-4c90-8d09-769032af5ffa</guid>
            <external-id/>
            <parent-id>41</parent-id>
          </domain>
          <domain>
            <id>7</id>
            <name>subsers.ru</name>
            <ascii-name>subsers.ru</ascii-name>
            <type>alias</type>
            <main>false</main>
            <guid>91755d52-849a-45f9-8808-3fc35d913670</guid>
            <external-id/>
            <domain-id>41</domain-id>
          </domain>
        </domains>
      </result>
    </get-domain-list>  
  </reseller>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.