GET api/WidgetMenu?dashboardType={dashboardType}

Gets all the widgets details for login user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dashboardType

1 - Realtime/ 2 - Periodical

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

List of WidgetDetails

Collection of WidgetDetails
NameDescriptionTypeAdditional information
wid

integer

None.

Title

string

None.

SubTitle

string

None.

IconClass

string

None.

FlexClass

string

None.

TemplateURL

string

None.

Code

string

None.

HasMenuItems

integer

None.

MenuItems

Collection of WidgetMenuItem

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "wid": 1,
    "Title": "sample string 2",
    "SubTitle": "sample string 3",
    "IconClass": "sample string 4",
    "FlexClass": "sample string 5",
    "TemplateURL": "sample string 6",
    "Code": "sample string 7",
    "HasMenuItems": 8,
    "MenuItems": [
      {
        "Title": "sample string 1",
        "Description": "sample string 2",
        "Url": "sample string 3",
        "TemplateUrl": "sample string 4",
        "TemplateController": "sample string 5",
        "IconClass": "sample string 6"
      },
      {
        "Title": "sample string 1",
        "Description": "sample string 2",
        "Url": "sample string 3",
        "TemplateUrl": "sample string 4",
        "TemplateController": "sample string 5",
        "IconClass": "sample string 6"
      }
    ]
  },
  {
    "wid": 1,
    "Title": "sample string 2",
    "SubTitle": "sample string 3",
    "IconClass": "sample string 4",
    "FlexClass": "sample string 5",
    "TemplateURL": "sample string 6",
    "Code": "sample string 7",
    "HasMenuItems": 8,
    "MenuItems": [
      {
        "Title": "sample string 1",
        "Description": "sample string 2",
        "Url": "sample string 3",
        "TemplateUrl": "sample string 4",
        "TemplateController": "sample string 5",
        "IconClass": "sample string 6"
      },
      {
        "Title": "sample string 1",
        "Description": "sample string 2",
        "Url": "sample string 3",
        "TemplateUrl": "sample string 4",
        "TemplateController": "sample string 5",
        "IconClass": "sample string 6"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfWidgetDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sysmex.IT.NsGlobal.Models.Common">
  <WidgetDetails>
    <Code>sample string 7</Code>
    <FlexClass>sample string 5</FlexClass>
    <HasMenuItems>8</HasMenuItems>
    <IconClass>sample string 4</IconClass>
    <MenuItems>
      <WidgetMenuItem>
        <Description>sample string 2</Description>
        <IconClass>sample string 6</IconClass>
        <TemplateController>sample string 5</TemplateController>
        <TemplateUrl>sample string 4</TemplateUrl>
        <Title>sample string 1</Title>
        <Url>sample string 3</Url>
      </WidgetMenuItem>
      <WidgetMenuItem>
        <Description>sample string 2</Description>
        <IconClass>sample string 6</IconClass>
        <TemplateController>sample string 5</TemplateController>
        <TemplateUrl>sample string 4</TemplateUrl>
        <Title>sample string 1</Title>
        <Url>sample string 3</Url>
      </WidgetMenuItem>
    </MenuItems>
    <SubTitle>sample string 3</SubTitle>
    <TemplateURL>sample string 6</TemplateURL>
    <Title>sample string 2</Title>
    <wid>1</wid>
  </WidgetDetails>
  <WidgetDetails>
    <Code>sample string 7</Code>
    <FlexClass>sample string 5</FlexClass>
    <HasMenuItems>8</HasMenuItems>
    <IconClass>sample string 4</IconClass>
    <MenuItems>
      <WidgetMenuItem>
        <Description>sample string 2</Description>
        <IconClass>sample string 6</IconClass>
        <TemplateController>sample string 5</TemplateController>
        <TemplateUrl>sample string 4</TemplateUrl>
        <Title>sample string 1</Title>
        <Url>sample string 3</Url>
      </WidgetMenuItem>
      <WidgetMenuItem>
        <Description>sample string 2</Description>
        <IconClass>sample string 6</IconClass>
        <TemplateController>sample string 5</TemplateController>
        <TemplateUrl>sample string 4</TemplateUrl>
        <Title>sample string 1</Title>
        <Url>sample string 3</Url>
      </WidgetMenuItem>
    </MenuItems>
    <SubTitle>sample string 3</SubTitle>
    <TemplateURL>sample string 6</TemplateURL>
    <Title>sample string 2</Title>
    <wid>1</wid>
  </WidgetDetails>
</ArrayOfWidgetDetails>