Documentation for GET api/Extranet/Dashboard/{DashboardID}?localeID={localeID}

GET api/Extranet/Dashboard/{DashboardID}?localeID={localeID}

The user can call this API to retrieve all widgets associated with a particular dashboard.

Request Information

URI Parameters

Name	Description	Type	Additional information
DashboardID	The Dashboard ID that the user would like detailed information for.	integer	Required
localeID		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of WidgetZone

Name	Description	Type	Additional information
ColumnSpan	How many columns this widget zone will take	integer	None.
RowSpan	How many rows (depth) this widget zone will take	integer	None.
Width	The width (in either pixels or percentage) this widget zone should take	string	None.
ColumnIndex	The column index of the widget zone	integer	None.
Widgets	An array of widgets contained within the widget zone	Collection of Widget	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfWidgetZone>
  <WidgetZone>
    <ColumnSpan>1</ColumnSpan>
    <RowSpan>2</RowSpan>
    <Width>sample string 3</Width>
    <ColumnIndex>4</ColumnIndex>
    <Widgets>
      <Widget>
        <WidgetTitle>sample string 1</WidgetTitle>
        <WidgetSortOrder>sample string 2</WidgetSortOrder>
        <Text1>sample string 3</Text1>
        <Text2>sample string 4</Text2>
        <HeaderNote>sample string 5</HeaderNote>
        <FooterNote>sample string 6</FooterNote>
      </Widget>
      <Widget>
        <WidgetTitle>sample string 1</WidgetTitle>
        <WidgetSortOrder>sample string 2</WidgetSortOrder>
        <Text1>sample string 3</Text1>
        <Text2>sample string 4</Text2>
        <HeaderNote>sample string 5</HeaderNote>
        <FooterNote>sample string 6</FooterNote>
      </Widget>
    </Widgets>
  </WidgetZone>
  <WidgetZone>
    <ColumnSpan>1</ColumnSpan>
    <RowSpan>2</RowSpan>
    <Width>sample string 3</Width>
    <ColumnIndex>4</ColumnIndex>
    <Widgets>
      <Widget>
        <WidgetTitle>sample string 1</WidgetTitle>
        <WidgetSortOrder>sample string 2</WidgetSortOrder>
        <Text1>sample string 3</Text1>
        <Text2>sample string 4</Text2>
        <HeaderNote>sample string 5</HeaderNote>
        <FooterNote>sample string 6</FooterNote>
      </Widget>
      <Widget>
        <WidgetTitle>sample string 1</WidgetTitle>
        <WidgetSortOrder>sample string 2</WidgetSortOrder>
        <Text1>sample string 3</Text1>
        <Text2>sample string 4</Text2>
        <HeaderNote>sample string 5</HeaderNote>
        <FooterNote>sample string 6</FooterNote>
      </Widget>
    </Widgets>
  </WidgetZone>
</ListOfWidgetZone>

application/json, text/json

Sample:

[
  {
    "ColumnSpan": 1,
    "RowSpan": 2,
    "Width": "sample string 3",
    "ColumnIndex": 4,
    "Widgets": [
      {
        "WidgetTitle": "sample string 1",
        "WidgetSortOrder": "sample string 2",
        "Text1": "sample string 3",
        "Text2": "sample string 4",
        "HeaderNote": "sample string 5",
        "FooterNote": "sample string 6"
      },
      {
        "WidgetTitle": "sample string 1",
        "WidgetSortOrder": "sample string 2",
        "Text1": "sample string 3",
        "Text2": "sample string 4",
        "HeaderNote": "sample string 5",
        "FooterNote": "sample string 6"
      }
    ]
  },
  {
    "ColumnSpan": 1,
    "RowSpan": 2,
    "Width": "sample string 3",
    "ColumnIndex": 4,
    "Widgets": [
      {
        "WidgetTitle": "sample string 1",
        "WidgetSortOrder": "sample string 2",
        "Text1": "sample string 3",
        "Text2": "sample string 4",
        "HeaderNote": "sample string 5",
        "FooterNote": "sample string 6"
      },
      {
        "WidgetTitle": "sample string 1",
        "WidgetSortOrder": "sample string 2",
        "Text1": "sample string 3",
        "Text2": "sample string 4",
        "HeaderNote": "sample string 5",
        "FooterNote": "sample string 6"
      }
    ]
  }
]