Skip to main content

Method shows/sets user quotas.
quota is the amount of quotas.
limit is the amount to which the quotas reset after the specified period (see add-quota-to-portal).

Parameters

Parameter NameRequired?Notes
offsetNonumeric offset from where to fetch user quotas, default is 0
countNonumber of user quotas to return in response, default is 10
team-idNofilter user quotas by team
office-idNofilter user quotas by office
hideEmptyNoIf true, users, teams and offices that have no quotas set will not be displayed in the response.

Show user quotas

Example

Request

https://ws.idibu.com/ws/rest/v1/quotas/517/users?hash=YOUR_HASH

Response

<?xml version="1.0" encoding="utf8"?>
<idibu generator="idibu" version="1.0">
<response>
<quotas>
<quota>
<user-id>485</user-id>
<quota>100</quota>
<limit>50</limit>
<remaining>85</remaining>
<posted>15</posted>
</quota>
<quota>
<user-id>856</user-id>
<quota>1</quota>
<limit></limit>
</remaining>
</posted>
</quota>
<quota>
<user-id>1017</user-id>
<quota>1</quota>
<limit></limit>
</remaining>
</posted>
</quota>
<quota>
<user-id>1058</user-id>
<quota>3</quota>
<limit>5</limit>
</remaining>
</posted>
</quota>
<quota>
<user-id>1066</user-id>
<quota>5</quota>
<limit></limit>
</remaining>
</posted>
</quota>
<quota>
<user-id>1101</user-id>
<quota>4</quota>
<limit></limit>
<remaining>2</remaining>
<posted>2</posted>
</quota>
<quota>
<user-id>1168</user-id>
<quota>3</quota>
<limit>0</limit>
</remaining>
</posted>
</quota>
<quota>
<user-id>1198</user-id>
<quota>2</quota>
<limit></limit>
</remaining>
</posted>
</quota>
</quotas>
<total>8</total>
</response>
<status>success</status>
</idibu>

Set user quotas

To set quotas, please provide data parameter containig an xml as shown in the example below.

For *slots* type of quotas, limit parameter in xml can be omitted.

Example

Data posted

POST https://ws.idibu.com/ws/rest/v1/quotas/517/users?hash=YOUR_HASH
<?xml version="1.0"?>
<idibu>
<quota>
<user-id>33000171</user-id>
<quota>1</quota>
<limit></limit>
</quota>
<quota>
<user-id>33000172</user-id>
<quota>2</quota>
<limit>3</limit>
</quota>
</idibu>

Response

<?xml version="1.0" encoding="utf8"?>
<idibu generator="idibu" version="1.0">
<response>
<message>Quota set</message>
</response>
<status>success</status>
</idibu>