GET api/dashboardconfig?dashboardType={dashboardType}

Gets dashboard configurationn for a given dashboard type

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dashboardType

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of DashboardConfiguration
NameDescriptionTypeAdditional information
DashboardType

OptionSetValueModel

None.

Id

string

None.

DisplayOrder

integer

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DashboardType": {
      "Label": "sample string 1",
      "Value": 2
    },
    "Id": "sample string 1",
    "DisplayOrder": 2,
    "Description": "sample string 3"
  },
  {
    "DashboardType": {
      "Label": "sample string 1",
      "Value": 2
    },
    "Id": "sample string 1",
    "DisplayOrder": 2,
    "Description": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDashboardConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <DashboardConfiguration>
    <DashboardType xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Label>sample string 1</d3p1:Label>
      <d3p1:Value>2</d3p1:Value>
    </DashboardType>
    <Description>sample string 3</Description>
    <DisplayOrder>2</DisplayOrder>
    <Id>sample string 1</Id>
  </DashboardConfiguration>
  <DashboardConfiguration>
    <DashboardType xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
      <d3p1:Label>sample string 1</d3p1:Label>
      <d3p1:Value>2</d3p1:Value>
    </DashboardType>
    <Description>sample string 3</Description>
    <DisplayOrder>2</DisplayOrder>
    <Id>sample string 1</Id>
  </DashboardConfiguration>
</ArrayOfDashboardConfiguration>