JSON API » menus » menus/get

Gets the fields of a menu.

Input parameters

Requires authentication and the menus role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of menu to get.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The menu does not exist.

Data returned

Fields of menu.

Example: With required parameters

http://enswitch.example.com/api/json/menus/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

VersionChanges
3.13Function added.