GET api/Revolution/Menu?description={description}
This will return the menus in the normal parent/child association to allow for easier traversing. This is the recommended API to call for the average usage.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
description | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of RevolutionMenuItemName | Description | Type | Additional information |
---|---|---|---|
ID |
The ID for the Menu Item |
integer |
None. |
Title |
The Title (displayed link name) |
string |
None. |
Description |
The description (alt) for the menu item. Normally only used for sr (screen-reader) tags. |
string |
None. |
Url |
The URL/Link for the Menu Item. If the URL contains a "GOTO" within the URL. This references that the link is "virtual" and will link to the framed URL in the IFrameURL property. |
string |
None. |
Target |
The target (_blank as an example) for the link |
string |
None. |
CssClass |
The classes that should be used for the menu item. Some possible classes include xs-hidden, sm-hidden, etc. for bootstrap responsiveness; however, you are not required to use these if you don't want to. |
string |
None. |
TranslationKey |
This is the translation key for the menu item and while the translation is already provided for the menu item. Be aware that if the user updates their locale, you can use this to automatically (without updating the menu) retrieve the updated text. |
string |
None. |
IFrameUrl |
This is the IFrameURL used whenever the Url contains a "GOTO" |
string |
None. |
Style |
This denotes the style of the menu (typically hidden or blank meaning not hidden) |
string |
None. |
IncludedTerritories |
This is the territories that will show this menu item. Be aware, much like translations, this will be automatically filtered; however, they are given should the user change their country (should your system allow this) |
string |
None. |
AngularIcon |
This is the icon name. These are all tied to ByDesign's icons (for our own app usage), most of these tie to font-awesome but some are created internally, you're welcome to use your own interpretations (for styling), import font-awesome, or change the icon names within the Freedom Suite to whatever suites your needs. |
string |
None. |
ChildMenus |
This is the list of child menu items. For Revolution, we typically only go one level deep. |
Collection of RevolutionMenuItem |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample not available.