JSON API » menus » menus/available/list

Gets the fields of all menus visible to the user. To reduce database load, data is cached for up to one minute.

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
language	String	Language code.	No	Default language.
nested	Integer	1 to return sub-menus as nested children of their parent menus, 0 to return a flat array.	No	0

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 menus table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/menus/available/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.