GET api/Extranet/Dashboard

The user can call this API to get a list of all available Widgets Dashboards. This will give the user an idea of which dashboards are used within various territories. They can then use the DashboardID in order to get more specific information for a particular dashboard.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Dashboard
NameDescriptionTypeAdditional information
DashboardID

The identifier for a given Dashboard

 integer

None.
DashboardName

The name of the Dashboard. Example: “USA Dashboard”

 string

None.
TerritoryID

The programmatic identifier for the associated Territory.

 integer

None.
TerritoryName

The name of the associated Territory. Example: “USA”

 string

None.
Country

The Country associated to the Territory.

 string

None.
County

The County associated to the Territory.

 string

None.
State

The State associated to the Territory.

 string

None.
City

The City associated to the Territory.

 string

None.
PostalCode

The PostalCode associated to the Territory.

 string

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfDashboard>
  <Dashboard>
    <DashboardID>1</DashboardID>
    <DashboardName>sample string 2</DashboardName>
    <TerritoryID>3</TerritoryID>
    <TerritoryName>sample string 4</TerritoryName>
    <Country>sample string 5</Country>
    <County>sample string 6</County>
    <State>sample string 7</State>
    <City>sample string 8</City>
    <PostalCode>sample string 9</PostalCode>
  </Dashboard>
  <Dashboard>
    <DashboardID>1</DashboardID>
    <DashboardName>sample string 2</DashboardName>
    <TerritoryID>3</TerritoryID>
    <TerritoryName>sample string 4</TerritoryName>
    <Country>sample string 5</Country>
    <County>sample string 6</County>
    <State>sample string 7</State>
    <City>sample string 8</City>
    <PostalCode>sample string 9</PostalCode>
  </Dashboard>
</ListOfDashboard>

application/json, text/json

Sample: 
[
  {
    "DashboardID": 1,
    "DashboardName": "sample string 2",
    "TerritoryID": 3,
    "TerritoryName": "sample string 4",
    "Country": "sample string 5",
    "County": "sample string 6",
    "State": "sample string 7",
    "City": "sample string 8",
    "PostalCode": "sample string 9"
  },
  {
    "DashboardID": 1,
    "DashboardName": "sample string 2",
    "TerritoryID": 3,
    "TerritoryName": "sample string 4",
    "Country": "sample string 5",
    "County": "sample string 6",
    "State": "sample string 7",
    "City": "sample string 8",
    "PostalCode": "sample string 9"
  }
]