Retrieving Descriptor of Permissions

The get-permission-descriptor operation is used to retrieve descriptor of reseller's permissions. For details on descriptor, refer to the Representation of Object Descriptors section. For details on reseller's permissions, refer to the Permissions section.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving reseller permissions descriptor includes the get-permission-descriptor operation node:

<packet version="1.6.0.0">
<reseller>
   <get-permission-descriptor>
   ...
   </get-permission-descriptor>
</reseller>
</packet>

 

The get-permission-descriptor node has the following graphical representation:

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

  • The filter node is required. It specifies reseller accounts whose permissions descriptors are to be retrieved. Data type: ResellerSelectionFilter. To view the structure of this node, refer to the Available Filters section.
 

Response Packet Structure

A response get-permission-descriptor node is structured as follows:

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

  • The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (common.xsd).
    • The status node is required. It specifies the execution status of the get-permission-descriptor operation. Data type: result_status (common.xsd). Allowed values: ok|error.
    • The errcode node is required if the get-permission-descriptor operation fails. It returns the error code. Data type: unsignedInt.
    • The errtext node is required if the get-permission-descriptor operation fails. It returns the error message. Data type: string.
    • The filter-id node is required if the get-permission-descriptor operation succeeds. It returns parameter by which reseller account was filtered in the request packet. Data type: anySimple.
    • The id node is required if the get-permission-descriptor operation succeeds. It returns ID of the reseller account which permissions descriptor was displayed. Data type: id_type (common.xsd).
    • The descriptor node is required if the get-permission-descriptor operation succeeds. It specifies object descriptor. For details, refer to the Representation of Object Descriptors section. Data type: string.

      Note: This descriptor contains permission extensions. For details, refer to the Representation of Object Descriptors: Property Descriptor > Extension of Permissions Descriptor section.

 

Samples

The following packet retrieves permissions descriptor for a reseller account:

<packet version="1.6.0.0">
<reseller>
   <get-permission-descriptor>
      <filter>
         <login>JDoe</login>
      </filter>
   </get-permission-descriptor>
</reseller>
</packet>

A positive response received from the server looks as follows:

<packet version="1.6.0.0">
  <reseller>
    <get-permission-descriptor>
      <result>
        <status>ok</status>
        <filter-id>180</filter-id>
        <id>180</id>
        <descriptor>
           <property>
...
          </property>

		 <property>
			...
          </property>

        </descriptor>
      </result>
    </get-permission-descriptor>
  </reseller>
</packet>

 Note: Data structures that describe a number of properties are omitted to improve the readability of the sample.

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.