Retrieving the List of Customer's Domains
The get-domain-list operation is used to retrieve the list of customer's domains, subdomains, and domain aliases.
Request Packet Structure
A request XML packet includes the get-domain-list node:
The get-domain-list node is nested within the ClientTypeRequest complex type (client_input.xsd
). Its graphical representation is as follows:
- The filter node is required. It specifies the filtering rule. Data type: clientSelectionFilterType. For more information on filters, refer to the Available Filters section.
Response Packet Structure
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
).
-
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 request packet that retrieves information about customer's domains can look as follows:
Response: