Excluding All Apps from a Reseller Plan

Despite its name, the enable-aps-filter operation is not diametrically opposed to disable-aps-filter. The operation enable-aps-filter just clears the list of apps offered in a reseller plan. Thus you are able to manage the apps list (by add-package and remove-package) without calling this operation beforehand.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet clearing the list of apps available in a reseller plan includes the enable-aps-filter operation node:

<packet>
<reseller-plan>
   <enable-aps-filter>
   ...
   </enable-aps-filter>
</reseller-plan>
</packet>

The enable-aps-filter node is presented by type ResellerTemplateApsFilterInputType (reseller_template.xsd). Its graphical representation is as follows:

enable-aps-filter 1633

  • The filter node is required. It serves to specify the criteria by which the necessary service plans will be selected from the database. Data type: ResellerTemplateFilterType (domain_template.xsd). See the Available Filters section for details on this node.

 

Response Packet Structure

The enable-aps-filter node of the output XML packet is of complex type (domain_template.xsd) which has the following presentation:

enable-aps-filter response 1633

  • The result node is required. It wraps the response got from the server. Data type: resultFilterType (common.xsd).
  • The status node is required. Specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. Returns the error code when the operation fails. Data type: unsignedInt.
  • The errtext node is optional. Returns the error message if the operation fails. Data type: string.
  • The filter-id node is optional. Returns the parameter by which the reseller plan was filtered by in the request packet. Data type: anySimple.
  • The id node is optional. Returns the identifier of the reseller plan specified in the request. Data type: id_type (common.xsd).
 

Samples

This packet clears the list of apps available in the reseller plan base_plan.

<packet>
<reseller-plan>
<enable-aps-filter>
   <filter>
      <name>base_plan</name>
   </filter>
</enable-aps-filter>
</reseller-plan>
</packet>

Response:

<packet>
  <reseller-plan>
    <enable-aps-filter>
      <result>
        <status>ok</status>
        <filter-id>base_plan</filter-id>
      </result>
    </enable-aps-filter>
  </reseller-plan>
</packet>
 

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.