Filtering is the way a request XML packet indicates to which objects to apply an operation. Parameters nested in the filter node are called filtering rule.

The filter node is presented by the siteFilterType complex type (site.xsd). Its graphical representation is as follows:

image-siteFilterType

  • id, optional

    It specifies the site ID. Data type: integer.

  • parent-id, optional

    If specified, the filter matches only sites that are associated with a subscription that has a particular ID. Data type: integer.

  • parent-site-id, optional

    If specified, the filter matches only sites that are subdomains of a domain that has a particular ID. Data type: integer.

  • name, optional

    It specifies a site name. Data type: string.

  • parent-name, optional

    If specified, the filter matches only sites that are associated with a subscription that has a particular name. Data type: string.

  • parent-site-name, optional

    If specified, the filter matches only sites that are subdomains of a domain that has a particular name. Data type: string.

  • guid, optional

    It specifies the GUID of a site. Data type: string.

    Note: For details on GUIDs, refer to the XML API Protocol > GUIDs Overview.

  • parent-guid, optional

    If specified, the filter matches only sites that are associated with a subscription that has a particular GUID. Data type: string.

  • parent-site-guid, optional

    If specified, the filter matches only sites that are subdomains of a domain that has a particular GUID. Data type: string.

Examples

The following filter matches sites by id:

<filter>
   <id>124</id>
   <id>127</id>
</filter>

The following filter matches sites by names:

<filter>
   <name>example.com</name>
   <name>sample.com</name>
</filter>