Filtering Issues

This section describes some peculiarities of domain alias filtering.

Filtering is the way the request XML packet indicates the object (one or several domain aliases) to which the operation will be applied. The request XML filters domain aliases using a special filter section. When created, a domain alias is given a unique identifier and a unique name. Thus, to specify a domain alias (e.g. for the set or get operation), the packet needs a special filter section structured as follows:

The DomainAliasFilterType (domainalias_input.xsd) allows you to specify a domain alias either by id, name, primary domain id, or primary domain name. In addition, it allows you to specify multiple domain aliases within one filter. Finally, the filter can be left empty, which means that all domain aliases are selected.

• The id node is optional. It specifies the domain alias by id. Data type: integer.
• The name node is optional. It specifies the domain alias by name. Data type: string (Unicode).
• The domain_id node is optional. It specifies the domain alias by id of the primary domain. Data type: integer.
• The domain_name is optional. It specifies the domain alias by name of the primary domain. Data type: string (Unicode).

Note: Use <filter/> to update settings of all domain aliases on the server or delete all domain aliases from the server.

For example, a packet that retrieves the information about all domain aliases looks as follows:

<packet version="1.4.2.0">

<domain_alias>

<get>

   <filter/>

</get>

</domain_alias>

</packet>