GET api/menu/{appName}

Gets user's saved menu layout, if it exists, for a given application and the company they are logged on to. The default menu layout is returned if a user doesn't have their own customized menu layout saved. Applications that the user doesn't have access to via their Web token are automatically stripped from the menu.

Request Information

URI Parameters

Name	Description	Type	Additional information
appName	Application name to fetch the menu layout for. E.g. "CPP", "Retail" etc.	string	Required

Body Parameters

None.

Response Information

Resource Description

MenuDTO

Name	Description	Type	Additional information
NumberOfItemsLeft	Number of items positioned on the left in the menu.	integer	None.
ApplicationType	Application name that the menu layout is for. E.g. "CPP", "Retail" etc.	string	None.
MenuItems	A collection of menu items for the menu.	Collection of MenuItemDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "NumberOfItemsLeft": 1,
  "ApplicationType": "sample string 2",
  "MenuItems": [
    {
      "href": "sample string 1",
      "translateTag": "sample string 2",
      "klasa": "sample string 3",
      "submenuItems": [
        {
          "href": "sample string 1",
          "translateTag": "sample string 2"
        },
        {
          "href": "sample string 1",
          "translateTag": "sample string 2"
        }
      ]
    },
    {
      "href": "sample string 1",
      "translateTag": "sample string 2",
      "klasa": "sample string 3",
      "submenuItems": [
        {
          "href": "sample string 1",
          "translateTag": "sample string 2"
        },
        {
          "href": "sample string 1",
          "translateTag": "sample string 2"
        }
      ]
    }
  ]
}

text/html

Sample:

{"NumberOfItemsLeft":1,"ApplicationType":"sample string 2","MenuItems":[{"href":"sample string 1","translateTag":"sample string 2","klasa":"sample string 3","submenuItems":[{"href":"sample string 1","translateTag":"sample string 2"},{"href":"sample string 1","translateTag":"sample string 2"}]},{"href":"sample string 1","translateTag":"sample string 2","klasa":"sample string 3","submenuItems":[{"href":"sample string 1","translateTag":"sample string 2"},{"href":"sample string 1","translateTag":"sample string 2"}]}]}

application/xml, text/xml

Sample:

<MenuDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <ApplicationType>sample string 2</ApplicationType>
  <MenuItems>
    <MenuItemDTO>
      <href>sample string 1</href>
      <klasa>sample string 3</klasa>
      <submenuItems>
        <SubmenuItemDTO>
          <href>sample string 1</href>
          <translateTag>sample string 2</translateTag>
        </SubmenuItemDTO>
        <SubmenuItemDTO>
          <href>sample string 1</href>
          <translateTag>sample string 2</translateTag>
        </SubmenuItemDTO>
      </submenuItems>
      <translateTag>sample string 2</translateTag>
    </MenuItemDTO>
    <MenuItemDTO>
      <href>sample string 1</href>
      <klasa>sample string 3</klasa>
      <submenuItems>
        <SubmenuItemDTO>
          <href>sample string 1</href>
          <translateTag>sample string 2</translateTag>
        </SubmenuItemDTO>
        <SubmenuItemDTO>
          <href>sample string 1</href>
          <translateTag>sample string 2</translateTag>
        </SubmenuItemDTO>
      </submenuItems>
      <translateTag>sample string 2</translateTag>
    </MenuItemDTO>
  </MenuItems>
  <NumberOfItemsLeft>1</NumberOfItemsLeft>
</MenuDTO>