JSON API » preferences » preferences/list
Gets the fields of all the preferences that have been set for the authentication user.
Input parameters
Requires authentication and the user role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
Data returned
An array of fields, corresponding to the rows of the preferences table in the database.
Example: With required parameters
http://enswitch.example.com/api/json/preferences/list/?auth_username=user;auth_password=password{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "name":"callerid", ... }, { "name":"name", ... } }
Change history
Version | Changes |
---|---|
4.0 | Function added. |