GET Api/Comparison/LowestAnnualPlans/{stateCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
stateCode		string	Required

Body Parameters

None.

Response Information

Resource Description

ResultOfListOfLowestAnnualPlansResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	Collection of LowestAnnualPlansResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": [
    {
      "Provider": "sample string 1",
      "ContractLength": "sample string 2",
      "KeyFeatures": "sample string 3",
      "EstimateAnnualCost": 1.0,
      "AERBenchmarkConsumption": 1.0,
      "_Metadata": {
        "StateCode": "sample string 1",
        "StateName": "sample string 2",
        "DistributorName": "sample string 3",
        "TariffName": "sample string 4",
        "TariffType": "sample string 5",
        "RetailerName": "sample string 6",
        "PlanName": "sample string 7"
      }
    },
    {
      "Provider": "sample string 1",
      "ContractLength": "sample string 2",
      "KeyFeatures": "sample string 3",
      "EstimateAnnualCost": 1.0,
      "AERBenchmarkConsumption": 1.0,
      "_Metadata": {
        "StateCode": "sample string 1",
        "StateName": "sample string 2",
        "DistributorName": "sample string 3",
        "TariffName": "sample string 4",
        "TariffType": "sample string 5",
        "RetailerName": "sample string 6",
        "PlanName": "sample string 7"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResultOfArrayOfLowestAnnualPlansResult_S0_SH1S1i xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Comparisons">
    <d2p1:LowestAnnualPlansResult>
      <d2p1:AERBenchmarkConsumption>1</d2p1:AERBenchmarkConsumption>
      <d2p1:ContractLength>sample string 2</d2p1:ContractLength>
      <d2p1:EstimateAnnualCost>1</d2p1:EstimateAnnualCost>
      <d2p1:KeyFeatures>sample string 3</d2p1:KeyFeatures>
      <d2p1:Provider>sample string 1</d2p1:Provider>
      <d2p1:_Metadata>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:PlanName>sample string 7</d2p1:PlanName>
        <d2p1:RetailerName>sample string 6</d2p1:RetailerName>
        <d2p1:StateCode>sample string 1</d2p1:StateCode>
        <d2p1:StateName>sample string 2</d2p1:StateName>
        <d2p1:TariffName>sample string 4</d2p1:TariffName>
        <d2p1:TariffType>sample string 5</d2p1:TariffType>
      </d2p1:_Metadata>
    </d2p1:LowestAnnualPlansResult>
    <d2p1:LowestAnnualPlansResult>
      <d2p1:AERBenchmarkConsumption>1</d2p1:AERBenchmarkConsumption>
      <d2p1:ContractLength>sample string 2</d2p1:ContractLength>
      <d2p1:EstimateAnnualCost>1</d2p1:EstimateAnnualCost>
      <d2p1:KeyFeatures>sample string 3</d2p1:KeyFeatures>
      <d2p1:Provider>sample string 1</d2p1:Provider>
      <d2p1:_Metadata>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:PlanName>sample string 7</d2p1:PlanName>
        <d2p1:RetailerName>sample string 6</d2p1:RetailerName>
        <d2p1:StateCode>sample string 1</d2p1:StateCode>
        <d2p1:StateName>sample string 2</d2p1:StateName>
        <d2p1:TariffName>sample string 4</d2p1:TariffName>
        <d2p1:TariffType>sample string 5</d2p1:TariffType>
      </d2p1:_Metadata>
    </d2p1:LowestAnnualPlansResult>
  </Value>
</ResultOfArrayOfLowestAnnualPlansResult_S0_SH1S1i>