POST api/dashboard/GetDashboardResultsMultipleMonths

Request Information

URI Parameters

None.

Body Parameters

DashboardCriteria
NameDescriptionTypeAdditional information
Dashboard

string

None.

FromMonth

string

None.

ToMonth

string

None.

Filter1

string

None.

Filter2

string

None.

SLSPRSNID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Dashboard": "sample string 1",
  "FromMonth": "sample string 2",
  "ToMonth": "sample string 3",
  "Filter1": "sample string 4",
  "Filter2": "sample string 5",
  "SLSPRSNID": "sample string 6"
}

application/xml, text/xml

Sample:
<DashboardCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <Dashboard>sample string 1</Dashboard>
  <Filter1>sample string 4</Filter1>
  <Filter2>sample string 5</Filter2>
  <FromMonth>sample string 2</FromMonth>
  <SLSPRSNID>sample string 6</SLSPRSNID>
  <ToMonth>sample string 3</ToMonth>
</DashboardCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DashboardResults
NameDescriptionTypeAdditional information
MonthNumber

integer

None.

MonthName

string

None.

Year

integer

None.

RepSegment

string

None.

RepSegmentId

integer

None.

RepGroup

string

None.

SLSPRSNID

string

None.

SalesmanName

string

None.

ActualNmbr

decimal number

None.

BudgetNmbr

decimal number

None.

PriorNmbr

decimal number

None.

Prior2Nmbr

decimal number

None.

RealActualNmbr

decimal number

None.

RealBudgetNmbr

decimal number

None.

RealPriorNmbr

decimal number

None.

RealPrior2Nmbr

decimal number

None.

ShowRecord

boolean

None.

IncludeBudgets

boolean

None.

DashboardUM

string

None.

MapsAvailable

boolean

None.

ConvertUmMisses

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MonthNumber": 1,
    "MonthName": "sample string 2",
    "Year": 3,
    "RepSegment": "sample string 4",
    "RepSegmentId": 5,
    "RepGroup": "sample string 6",
    "SLSPRSNID": "sample string 7",
    "SalesmanName": "sample string 8",
    "ActualNmbr": 9.1,
    "BudgetNmbr": 10.1,
    "PriorNmbr": 11.1,
    "Prior2Nmbr": 12.1,
    "RealActualNmbr": 13.1,
    "RealBudgetNmbr": 14.1,
    "RealPriorNmbr": 15.1,
    "RealPrior2Nmbr": 16.1,
    "ShowRecord": true,
    "IncludeBudgets": true,
    "DashboardUM": "sample string 19",
    "MapsAvailable": true,
    "ConvertUmMisses": 21
  },
  {
    "MonthNumber": 1,
    "MonthName": "sample string 2",
    "Year": 3,
    "RepSegment": "sample string 4",
    "RepSegmentId": 5,
    "RepGroup": "sample string 6",
    "SLSPRSNID": "sample string 7",
    "SalesmanName": "sample string 8",
    "ActualNmbr": 9.1,
    "BudgetNmbr": 10.1,
    "PriorNmbr": 11.1,
    "Prior2Nmbr": 12.1,
    "RealActualNmbr": 13.1,
    "RealBudgetNmbr": 14.1,
    "RealPriorNmbr": 15.1,
    "RealPrior2Nmbr": 16.1,
    "ShowRecord": true,
    "IncludeBudgets": true,
    "DashboardUM": "sample string 19",
    "MapsAvailable": true,
    "ConvertUmMisses": 21
  }
]

application/xml, text/xml

Sample:
<ArrayOfDashboardResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <DashboardResults>
    <ActualNmbr>9.1</ActualNmbr>
    <BudgetNmbr>10.1</BudgetNmbr>
    <ConvertUmMisses>21</ConvertUmMisses>
    <DashboardUM>sample string 19</DashboardUM>
    <IncludeBudgets>true</IncludeBudgets>
    <MapsAvailable>true</MapsAvailable>
    <MonthName>sample string 2</MonthName>
    <MonthNumber>1</MonthNumber>
    <Prior2Nmbr>12.1</Prior2Nmbr>
    <PriorNmbr>11.1</PriorNmbr>
    <RealActualNmbr>13.1</RealActualNmbr>
    <RealBudgetNmbr>14.1</RealBudgetNmbr>
    <RealPrior2Nmbr>16.1</RealPrior2Nmbr>
    <RealPriorNmbr>15.1</RealPriorNmbr>
    <RepGroup>sample string 6</RepGroup>
    <RepSegment>sample string 4</RepSegment>
    <RepSegmentId>5</RepSegmentId>
    <SLSPRSNID>sample string 7</SLSPRSNID>
    <SalesmanName>sample string 8</SalesmanName>
    <ShowRecord>true</ShowRecord>
    <Year>3</Year>
  </DashboardResults>
  <DashboardResults>
    <ActualNmbr>9.1</ActualNmbr>
    <BudgetNmbr>10.1</BudgetNmbr>
    <ConvertUmMisses>21</ConvertUmMisses>
    <DashboardUM>sample string 19</DashboardUM>
    <IncludeBudgets>true</IncludeBudgets>
    <MapsAvailable>true</MapsAvailable>
    <MonthName>sample string 2</MonthName>
    <MonthNumber>1</MonthNumber>
    <Prior2Nmbr>12.1</Prior2Nmbr>
    <PriorNmbr>11.1</PriorNmbr>
    <RealActualNmbr>13.1</RealActualNmbr>
    <RealBudgetNmbr>14.1</RealBudgetNmbr>
    <RealPrior2Nmbr>16.1</RealPrior2Nmbr>
    <RealPriorNmbr>15.1</RealPriorNmbr>
    <RepGroup>sample string 6</RepGroup>
    <RepSegment>sample string 4</RepSegment>
    <RepSegmentId>5</RepSegmentId>
    <SLSPRSNID>sample string 7</SLSPRSNID>
    <SalesmanName>sample string 8</SalesmanName>
    <ShowRecord>true</ShowRecord>
    <Year>3</Year>
  </DashboardResults>
</ArrayOfDashboardResults>