JSON API » plans » plans/features/maximum
Gets the maximum number of a feature a customer may create.
Input parameters
Requires authentication and the settings or user role privileges.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| feature | String | Feature to check. | Yes | |
| customer | Integer | ID of customer to check for. | No | See below. |
If customer is not specified, then the customer of the authentication user is used, unless auth_username indicates that the user is a customer pseudo-user, in which case the parent of the authentication user is used.
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
Data returned
The maximum allowed. 0 forbids a feature completely. -1 means no limit.
Example: With required parameters
http://enswitch.example.com/api/json/plans/features/maximum/?auth_username=user;auth_password=password;feature=view{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "maximum":-1 } }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |