Documentation for GET api/shopping/dashboard/incentive

GET api/shopping/dashboard/incentive

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DashboardViewModel

Name	Type	Additional information
Component	string	None.
SortOrder	integer	None.
Html	string	None.
CustomValue1	string	None.
CustomValue2	string	None.
CustomValue3	string	None.
Width	integer	None.
Description	string	None.
WidgetValues	Collection of WidgetValuesViewModel	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfDashboardViewModel>
  <DashboardViewModel>
    <Component>sample string 1</Component>
    <SortOrder>2</SortOrder>
    <Html>sample string 3</Html>
    <CustomValue1>sample string 4</CustomValue1>
    <CustomValue2>sample string 5</CustomValue2>
    <CustomValue3>sample string 6</CustomValue3>
    <Width>7</Width>
    <Description>sample string 8</Description>
    <WidgetValues>
      <WidgetValuesViewModel>
        <ID>1</ID>
        <Value>sample string 2</Value>
        <ProgrammingKey>sample string 3</ProgrammingKey>
      </WidgetValuesViewModel>
      <WidgetValuesViewModel>
        <ID>1</ID>
        <Value>sample string 2</Value>
        <ProgrammingKey>sample string 3</ProgrammingKey>
      </WidgetValuesViewModel>
    </WidgetValues>
  </DashboardViewModel>
  <DashboardViewModel>
    <Component>sample string 1</Component>
    <SortOrder>2</SortOrder>
    <Html>sample string 3</Html>
    <CustomValue1>sample string 4</CustomValue1>
    <CustomValue2>sample string 5</CustomValue2>
    <CustomValue3>sample string 6</CustomValue3>
    <Width>7</Width>
    <Description>sample string 8</Description>
    <WidgetValues>
      <WidgetValuesViewModel>
        <ID>1</ID>
        <Value>sample string 2</Value>
        <ProgrammingKey>sample string 3</ProgrammingKey>
      </WidgetValuesViewModel>
      <WidgetValuesViewModel>
        <ID>1</ID>
        <Value>sample string 2</Value>
        <ProgrammingKey>sample string 3</ProgrammingKey>
      </WidgetValuesViewModel>
    </WidgetValues>
  </DashboardViewModel>
</ListOfDashboardViewModel>

application/json, text/json

Sample:

[
  {
    "Component": "sample string 1",
    "SortOrder": 2,
    "Html": "sample string 3",
    "CustomValue1": "sample string 4",
    "CustomValue2": "sample string 5",
    "CustomValue3": "sample string 6",
    "Width": 7,
    "Description": "sample string 8",
    "WidgetValues": [
      {
        "ID": 1,
        "Value": "sample string 2",
        "ProgrammingKey": "sample string 3"
      },
      {
        "ID": 1,
        "Value": "sample string 2",
        "ProgrammingKey": "sample string 3"
      }
    ]
  },
  {
    "Component": "sample string 1",
    "SortOrder": 2,
    "Html": "sample string 3",
    "CustomValue1": "sample string 4",
    "CustomValue2": "sample string 5",
    "CustomValue3": "sample string 6",
    "Width": 7,
    "Description": "sample string 8",
    "WidgetValues": [
      {
        "ID": 1,
        "Value": "sample string 2",
        "ProgrammingKey": "sample string 3"
      },
      {
        "ID": 1,
        "Value": "sample string 2",
        "ProgrammingKey": "sample string 3"
      }
    ]
  }
]