JSON API » fields » fields/allowed/list

Gets the fields of all allowed values for a custom field. Only used for custom fields with type "allowed".

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
field	Integer	ID of field.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The custom field does not exist.

Data returned

An array of fields, corresponding to the rows of the fields_allowed table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/fields/allowed/list/?auth_username=user;auth_password=password;field=1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "field":1, "value":"example1", "display":"Example 1" }, { "field":1, "value":"example2", "display":"Example 2" } ] }

Change history

Version	Changes
4.0	Function added.