The get-domain-list operation is used to retrieve the list of customer's domains, subdomains, and domain aliases.
A request XML packet includes the get-domain-list node:
<packet>
<customer>
<get-domain-list>
...
</get-domain-list>
</customer>
</packet>
The get-domain-list node is nested within the ClientTypeRequest complex type (client_input.xsd
). Its graphical representation is as follows:
The get-domain-list node of the response packet is structured as follows:
The result node wraps the response retrieved from the server. Data type: resultFilterType (common.xsd
).
common.xsd
). 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 request packet that retrieves information about customer's domains can look as follows:
<packet>
<customer>
<get-domain-list>
<filter>
<id>1</id>
</filter>
</get-domain-list>
</customer>
</packet>
Response:
<packet>
<customer>
<get-domain-list>
<result>
<status>ok</status>
<filter-id>31</filter-id>
<id>31</id>
<domains>
<domain>
<id>37</id>
<name>jsmith111.com</name>
<ascii-name>jsmith111.com</ascii-name>
<type>domain</type>
<main>true</main>
<guid>9a82a132-601a-4cd0-9f81-4b4321eedfed</guid>
<external-id/>
</domain>
<domain>
<id>39</id>
<name>sub1.jsmith111.com</name>
<ascii-name>sub1.jsmith111.com</ascii-name>
<type>subdomain</type>
<main>false</main>
<guid>6d4624ef-3acb-42da-89db-be18d3d72aa8</guid>
<external-id/>
<parent-id>37</parent-id>
</domain>
<domain>
<id>40</id>
<name>sub2.jsmith111.com</name>
<ascii-name>sub2.jsmith111.com</ascii-name>
<type>subdomain</type>
<main>false</main>
<guid>f827f280-c850-4737-8029-16a4ba2a732b</guid>
<external-id/>
<parent-id>37</parent-id>
</domain>
<domain>
<id>6</id>
<name>aliassmith.com</name>
<ascii-name>aliassmith.com</ascii-name>
<type>alias</type>
<main>false</main>
<guid>9a82a132-601a-4cd0-9f81-4b4321eedfed</guid>
<external-id/>
<domain-id>37</domain-id>
</domain>
<domain>
<id>38</id>
<name>adddom1.com</name>
<ascii-name>adddom1.com</ascii-name>
<type>domain</type>
<main>false</main>
<guid>49344458-75c7-4dad-8439-d74e01ce6bb8</guid>
<external-id/>
</domain>
</domains>
</result>
</get-domain-list>
</customer>
</packet>