POST Api/Comparison/PlanRankings

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EnergyTypeID	integer	Required
CustomerTypeID	integer	Required
Distributor	string	None.
Nmi	string	None.
Postcode	string	Required
Suburb	string	Required
UsageLevel	string	None.

Request Formats

application/json, text/json

Sample:

{
  "EnergyTypeID": 1,
  "CustomerTypeID": 1,
  "Distributor": "sample string 1",
  "Nmi": "sample string 2",
  "Postcode": "sample string 3",
  "Suburb": "sample string 4",
  "UsageLevel": "sample string 5"
}

application/xml, text/xml

Sample:

<ParamPlanRanking xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewPlans.Parameters">
  <CustomerTypeID>1</CustomerTypeID>
  <Distributor>sample string 1</Distributor>
  <EnergyTypeID>1</EnergyTypeID>
  <Nmi>sample string 2</Nmi>
  <Postcode>sample string 3</Postcode>
  <Suburb>sample string 4</Suburb>
  <UsageLevel>sample string 5</UsageLevel>
</ParamPlanRanking>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfPlanRankingData

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "EnergyTypeID": 1,
    "CustomerTypeID": 1,
    "Distributor": "sample string 1",
    "Nmi": "sample string 2",
    "Postcode": "sample string 3",
    "Suburb": "sample string 4",
    "StateCode": "sample string 5",
    "UsageLevel": "sample string 6",
    "TotalData": 7,
    "Detail": [
      {
        "Rank": 1,
        "RetailerPlanName": "sample string 2",
        "LowestAnnual": "sample string 3",
        "SavingsPercentage": "sample string 4",
        "TotalEstimateCost": "sample string 5",
        "Scripting3": "sample string 6"
      },
      {
        "Rank": 1,
        "RetailerPlanName": "sample string 2",
        "LowestAnnual": "sample string 3",
        "SavingsPercentage": "sample string 4",
        "TotalEstimateCost": "sample string 5",
        "Scripting3": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResultOfPlanRankingDataFrQ0n142 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.NewPlans.Returns">
    <d2p1:CustomerTypeID>1</d2p1:CustomerTypeID>
    <d2p1:Detail>
      <d2p1:PlanRankingDataDetail>
        <d2p1:LowestAnnual>sample string 3</d2p1:LowestAnnual>
        <d2p1:Rank>1</d2p1:Rank>
        <d2p1:RetailerPlanName>sample string 2</d2p1:RetailerPlanName>
        <d2p1:SavingsPercentage>sample string 4</d2p1:SavingsPercentage>
        <d2p1:Scripting3>sample string 6</d2p1:Scripting3>
        <d2p1:TotalEstimateCost>sample string 5</d2p1:TotalEstimateCost>
      </d2p1:PlanRankingDataDetail>
      <d2p1:PlanRankingDataDetail>
        <d2p1:LowestAnnual>sample string 3</d2p1:LowestAnnual>
        <d2p1:Rank>1</d2p1:Rank>
        <d2p1:RetailerPlanName>sample string 2</d2p1:RetailerPlanName>
        <d2p1:SavingsPercentage>sample string 4</d2p1:SavingsPercentage>
        <d2p1:Scripting3>sample string 6</d2p1:Scripting3>
        <d2p1:TotalEstimateCost>sample string 5</d2p1:TotalEstimateCost>
      </d2p1:PlanRankingDataDetail>
    </d2p1:Detail>
    <d2p1:Distributor>sample string 1</d2p1:Distributor>
    <d2p1:EnergyTypeID>1</d2p1:EnergyTypeID>
    <d2p1:Nmi>sample string 2</d2p1:Nmi>
    <d2p1:Postcode>sample string 3</d2p1:Postcode>
    <d2p1:StateCode>sample string 5</d2p1:StateCode>
    <d2p1:Suburb>sample string 4</d2p1:Suburb>
    <d2p1:TotalData>7</d2p1:TotalData>
    <d2p1:UsageLevel>sample string 6</d2p1:UsageLevel>
  </Value>
</ResultOfPlanRankingDataFrQ0n142>