GET api/earnings?dataType={dataType}&period={period}&isYTD={isYTD}

Request Information

URI Parameters

Name	Type	Additional information
dataType	EarningComparisonDataType	Required
period	string	Required
isYTD	CumulativeType	Default value is None

Body Parameters

None.

Response Information

Resource Description

EarningComparisonDTO

Name	Type	Additional information
DataType	EarningComparisonDataType	Required
Period	string	None.
Period1	string	Required
Period2	string	Required
Items	Collection of RowEarningComparisonDTO	Required
PreviousPeriod	string	None.
PreviousYearPeriod	string	None.
PreviousPeriodItems	Collection of RowEarningComparisonDTO	None.
PreviousYearPeriodItems	Collection of RowEarningComparisonDTO	None.
ForecastItems	Collection of RowEarningComparisonDTO	None.
FFOvsAFFOItems	Collection of RowEarningComparisonDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "DataType": "FFO",
  "Period": "sample string 1",
  "Period1": "sample string 2",
  "Period2": "sample string 3",
  "Items": [
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    },
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    }
  ],
  "PreviousPeriod": "sample string 4",
  "PreviousYearPeriod": "sample string 5",
  "PreviousPeriodItems": [
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    },
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    }
  ],
  "PreviousYearPeriodItems": [
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    },
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    }
  ],
  "ForecastItems": [
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    },
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    }
  ],
  "FFOvsAFFOItems": [
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    },
    {
      "Type": "RentalRevenue",
      "Value1": 1.0,
      "Value2": 1.0,
      "Variance": {
        "Value": 1.0,
        "Delta": 1.0
      }
    }
  ]
}