Available Filters

Filtering is the way the request XML packet indicates the object (a LP or several) to which the operation will be applied. The request XML packet filters LPs using a special filter node.

Parameters, nested in the filter node are called filtering rule. A filter contains as many different filtering rule types as the number of different parameters nested in the XML presentation of the filter node. A single operation can use only parameters of the same type in the filtering rule.

In this chapter:

Filter for Language Packs

filter-id

 

Filter for Language Packs

The filter for this operator is presented by type LocaleFilterType (locale.xsd) and structured as follows:

LocaleFilter

  • The id node is optional. It specifies name of a LP. For details on LP names, refer to the LP Names section. Data type: string.

 

Remarks

The filter node can be left blank (<filter/>). In this case all LP's on the server will be matched.

A single filter can specify multiple LP names. The filter that matches the US English and Taiwan Chinese LP's looks as follows:

   <filter>
      <id>en-US</id>
      <id>zh-TW</id>
   </filter>

 

 

filter-id

If an operation in a request packet uses filters, the filter-id node is nested in a response packet. It returns the filtering rule parameter. If LP name was set as a filter rule parameter, it is returned in the filter-id node of the response packet.

It is done to trace the request parameters in case of error. Data type: anySimple.

 

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.