The get-limit-descriptor operation is used to retrieve descriptor of a reseller's limits. For details on the limits descriptors, refer to the Representation of Object Descriptors section. For details on reseller's limits, refer to the Limits section.
A request XML packet retrieving reseller limits descriptor includes the get-limit-descriptor operation node:
<packet version="1.6.0.0">
<reseller>
<get-limit-descriptor>
...
</get-limit-descriptor>
</reseller>
</packet>
The get-limit-descriptor node has the following graphical representation:
A response get-limit-descriptor node is structured as follows:
common.xsd
).common.xsd
). Allowed values: ok|error
.common.xsd
).Note: This descriptor contains limits extensions. For details, refer to the Representation of Object Descriptors: Property Descriptor > Extension of Limits Descriptor section.
The following packet retrieves limits descriptor for a reseller account:
<packet version="1.6.0.0">
<reseller>
<get-limit-descriptor>
<filter>
<login>JDoe</login>
</filter>
</get-limit-descriptor>
</reseller>
</packet>
Response:
<packet version="1.6.0.0">
<reseller>
<get-limit-descriptor>
<result>
<status>ok</status>
<filter-id>180</filter-id>
<id>180</id>
<descriptor>
<property>
<name>max_dom</name>
<type>int</type>
<writable-by>admin</writable-by>
<label>limit__max_dom</label>
<extension>
<shared>false</shared>
</extension>
</property>
<property>
...
</property>
</descriptor>
</result>
</get-limit-descriptor>
</reseller>
</packet>
Note: Data structures that describe a number of properties are omitted to improve the readability of the sample.