GET Household/{householdId}/Performance?FromDate={FromDate}&ToDate={ToDate}

Gets the performance for the specified household identifier and performance request.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
householdId

The household identifier.

integer

Required

FromDate

The beginning date to pull performance for

date

None.

ToDate

The end date to pull performance for

date

None.

Body Parameters

None.

Response Information

Resource Description

Returns household performance information in a PerformanceModel object.

Type: PerformanceModel
NameDescriptionTypeAdditional information
AsOfDate

The date that the values were calculated as of

date

None.

PerformancePeriods

A list of performance values with corresponding dates

Collection of PerformancePeriodModel

None.

Response Formats

application/json, text/json

Sample:
{
  "AsOfDate": "2018-07-22T02:15:17.1916418-04:00",
  "PerformancePeriods": [
    {
      "Date": "2018-07-22T02:15:17.1916418-04:00",
      "NetRateOfReturn": 1.5,
      "GrossRateOfReturn": 2.0
    },
    {
      "Date": "2018-07-22T02:15:17.1916418-04:00",
      "NetRateOfReturn": 3.0,
      "GrossRateOfReturn": 5.0
    }
  ]
}

application/xml, text/xml

Sample:
<PerformanceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <AsOfDate>2018-07-22T02:15:17.1916418-04:00</AsOfDate>
  <PerformancePeriods>
    <PerformancePeriodModel>
      <Date>2018-07-22T02:15:17.1916418-04:00</Date>
      <GrossRateOfReturn>2</GrossRateOfReturn>
      <NetRateOfReturn>1.5</NetRateOfReturn>
    </PerformancePeriodModel>
    <PerformancePeriodModel>
      <Date>2018-07-22T02:15:17.1916418-04:00</Date>
      <GrossRateOfReturn>5</GrossRateOfReturn>
      <NetRateOfReturn>3</NetRateOfReturn>
    </PerformancePeriodModel>
  </PerformancePeriods>
</PerformanceModel>