GET Api/Comparison/LowestAnnualWPWidgetFilters?stateId={stateId}&distributorId={distributorId}&tariffName={tariffName}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
stateId

integer

None.

distributorId

integer

None.

tariffName

string

None.

Body Parameters

None.

Response Information

Resource Description

ResultOfLowestAnnualWPWidgetFilter
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

ErrorMessage

Collection of string

None.

Value

LowestAnnualWPWidgetFilter

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "States": [
      {
        "StateId": 1,
        "StateCode": "sample string 2",
        "StateName": "sample string 3"
      },
      {
        "StateId": 1,
        "StateCode": "sample string 2",
        "StateName": "sample string 3"
      }
    ],
    "Distributors": [
      {
        "DistributorId": 1,
        "StateId": 2,
        "DistributorName": "sample string 3"
      },
      {
        "DistributorId": 1,
        "StateId": 2,
        "DistributorName": "sample string 3"
      }
    ],
    "TariffTypeMapings": [
      {
        "TariffName": "sample string 1",
        "TariffTypes": [
          {
            "TariffType": "sample string 1"
          },
          {
            "TariffType": "sample string 1"
          }
        ]
      },
      {
        "TariffName": "sample string 1",
        "TariffTypes": [
          {
            "TariffType": "sample string 1"
          },
          {
            "TariffType": "sample string 1"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResultOfLowestAnnualWPWidgetFilter_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:Distributors>
      <d2p1:LowestAnnualWPWidgetFilter.Distributor>
        <d2p1:DistributorId>1</d2p1:DistributorId>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:StateId>2</d2p1:StateId>
      </d2p1:LowestAnnualWPWidgetFilter.Distributor>
      <d2p1:LowestAnnualWPWidgetFilter.Distributor>
        <d2p1:DistributorId>1</d2p1:DistributorId>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:StateId>2</d2p1:StateId>
      </d2p1:LowestAnnualWPWidgetFilter.Distributor>
    </d2p1:Distributors>
    <d2p1:States>
      <d2p1:LowestAnnualWPWidgetFilter.State>
        <d2p1:StateCode>sample string 2</d2p1:StateCode>
        <d2p1:StateId>1</d2p1:StateId>
        <d2p1:StateName>sample string 3</d2p1:StateName>
      </d2p1:LowestAnnualWPWidgetFilter.State>
      <d2p1:LowestAnnualWPWidgetFilter.State>
        <d2p1:StateCode>sample string 2</d2p1:StateCode>
        <d2p1:StateId>1</d2p1:StateId>
        <d2p1:StateName>sample string 3</d2p1:StateName>
      </d2p1:LowestAnnualWPWidgetFilter.State>
    </d2p1:States>
    <d2p1:TariffTypeMapings>
      <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping>
        <d2p1:TariffName>sample string 1</d2p1:TariffName>
        <d2p1:TariffTypes>
          <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
            <d2p1:TariffType>sample string 1</d2p1:TariffType>
          </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
          <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
            <d2p1:TariffType>sample string 1</d2p1:TariffType>
          </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
        </d2p1:TariffTypes>
      </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping>
      <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping>
        <d2p1:TariffName>sample string 1</d2p1:TariffName>
        <d2p1:TariffTypes>
          <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
            <d2p1:TariffType>sample string 1</d2p1:TariffType>
          </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
          <d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
            <d2p1:TariffType>sample string 1</d2p1:TariffType>
          </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping.Tariff>
        </d2p1:TariffTypes>
      </d2p1:LowestAnnualWPWidgetFilter.TariffTypeMapping>
    </d2p1:TariffTypeMapings>
  </Value>
</ResultOfLowestAnnualWPWidgetFilter_S0_SH1S1i>