POST Api/Comparison/PlanSelection

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PresaleID	integer	None.
ElectricityPlanID	integer	None.
ElectricityRateID	integer	None.
GasPlanID	integer	None.
InternetPlanID	integer	None.
GasRateID	integer	None.
AgentID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PresaleID": 1,
  "ElectricityPlanID": 1,
  "ElectricityRateID": 1,
  "GasPlanID": 1,
  "InternetPlanID": 1,
  "GasRateID": 1,
  "AgentID": 1
}

application/xml, text/xml

Sample:

<ParamSelectPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Comparisons.Parameter">
  <AgentID>1</AgentID>
  <ElectricityPlanID>1</ElectricityPlanID>
  <ElectricityRateID>1</ElectricityRateID>
  <GasPlanID>1</GasPlanID>
  <GasRateID>1</GasRateID>
  <InternetPlanID>1</InternetPlanID>
  <PresaleID>1</PresaleID>
</ParamSelectPlan>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfComparisonSelectionResult

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "SelectionStatus": true,
    "PresaleID": 1,
    "CustomerTypeID": 1,
    "CustomerTypeName": "sample string 2",
    "IsMoving": true,
    "MovingStatus": "sample string 3",
    "StateCode": "sample string 4",
    "EnergyTypeID": 1,
    "EnergyTypeName": "sample string 5",
    "CurrentElecRetailerID": 1,
    "CurrentElecRetailerName": "sample string 6",
    "CurrentGasRetailerID": 1,
    "CurrentGasRetailerName": "sample string 7",
    "CurrentInternetRetailerID": 1,
    "CurrentInternetRetailerName": "sample string 8",
    "ElectrictyDetail": {
      "PlanID": 1,
      "PlanName": "sample string 1",
      "SignUpSummary": "sample string 2",
      "RateSection": "sample string 3",
      "TermsCondition": "sample string 4",
      "RetailerID": 1,
      "RetailerName": "sample string 5",
      "DistributorID": 1,
      "DistributorName": "sample string 6"
    },
    "GasDetail": {
      "PlanID": 1,
      "PlanName": "sample string 1",
      "SignUpSummary": "sample string 2",
      "RateSection": "sample string 3",
      "TermsCondition": "sample string 4",
      "RetailerID": 1,
      "RetailerName": "sample string 5",
      "DistributorID": 1,
      "DistributorName": "sample string 6"
    },
    "InternetDetail": {
      "PlanID": 1,
      "PlanName": "sample string 1",
      "RetailerID": 1,
      "RetailerName": "sample string 2",
      "ServiceType": "sample string 3",
      "DataAllowance": "sample string 4",
      "ContractType": "sample string 5",
      "ContractTerm": "sample string 6",
      "NBNSpeed": 1,
      "AverageEveningSpeed": 1,
      "ADSLSpeed": 1,
      "MonthlyCost": 1.0,
      "SetupCost": 1.0,
      "MinCost": 1.0,
      "ElecBundleCredit": 1,
      "GasBundleCredit": 1,
      "TotalBundleCredit": 1
    }
  }
}

application/xml, text/xml

Sample:

<ResultOfComparisonSelectionResult_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:CurrentElecRetailerID>1</d2p1:CurrentElecRetailerID>
    <d2p1:CurrentElecRetailerName>sample string 6</d2p1:CurrentElecRetailerName>
    <d2p1:CurrentGasRetailerID>1</d2p1:CurrentGasRetailerID>
    <d2p1:CurrentGasRetailerName>sample string 7</d2p1:CurrentGasRetailerName>
    <d2p1:CurrentInternetRetailerID>1</d2p1:CurrentInternetRetailerID>
    <d2p1:CurrentInternetRetailerName>sample string 8</d2p1:CurrentInternetRetailerName>
    <d2p1:CustomerTypeID>1</d2p1:CustomerTypeID>
    <d2p1:CustomerTypeName>sample string 2</d2p1:CustomerTypeName>
    <d2p1:ElectrictyDetail>
      <d2p1:DistributorID>1</d2p1:DistributorID>
      <d2p1:DistributorName>sample string 6</d2p1:DistributorName>
      <d2p1:PlanID>1</d2p1:PlanID>
      <d2p1:PlanName>sample string 1</d2p1:PlanName>
      <d2p1:RateSection>sample string 3</d2p1:RateSection>
      <d2p1:RetailerID>1</d2p1:RetailerID>
      <d2p1:RetailerName>sample string 5</d2p1:RetailerName>
      <d2p1:SignUpSummary>sample string 2</d2p1:SignUpSummary>
      <d2p1:TermsCondition>sample string 4</d2p1:TermsCondition>
    </d2p1:ElectrictyDetail>
    <d2p1:EnergyTypeID>1</d2p1:EnergyTypeID>
    <d2p1:EnergyTypeName>sample string 5</d2p1:EnergyTypeName>
    <d2p1:GasDetail>
      <d2p1:DistributorID>1</d2p1:DistributorID>
      <d2p1:DistributorName>sample string 6</d2p1:DistributorName>
      <d2p1:PlanID>1</d2p1:PlanID>
      <d2p1:PlanName>sample string 1</d2p1:PlanName>
      <d2p1:RateSection>sample string 3</d2p1:RateSection>
      <d2p1:RetailerID>1</d2p1:RetailerID>
      <d2p1:RetailerName>sample string 5</d2p1:RetailerName>
      <d2p1:SignUpSummary>sample string 2</d2p1:SignUpSummary>
      <d2p1:TermsCondition>sample string 4</d2p1:TermsCondition>
    </d2p1:GasDetail>
    <d2p1:InternetDetail>
      <d2p1:ADSLSpeed>1</d2p1:ADSLSpeed>
      <d2p1:AverageEveningSpeed>1</d2p1:AverageEveningSpeed>
      <d2p1:ContractTerm>sample string 6</d2p1:ContractTerm>
      <d2p1:ContractType>sample string 5</d2p1:ContractType>
      <d2p1:DataAllowance>sample string 4</d2p1:DataAllowance>
      <d2p1:ElecBundleCredit>1</d2p1:ElecBundleCredit>
      <d2p1:GasBundleCredit>1</d2p1:GasBundleCredit>
      <d2p1:MinCost>1</d2p1:MinCost>
      <d2p1:MonthlyCost>1</d2p1:MonthlyCost>
      <d2p1:NBNSpeed>1</d2p1:NBNSpeed>
      <d2p1:PlanID>1</d2p1:PlanID>
      <d2p1:PlanName>sample string 1</d2p1:PlanName>
      <d2p1:RetailerID>1</d2p1:RetailerID>
      <d2p1:RetailerName>sample string 2</d2p1:RetailerName>
      <d2p1:ServiceType>sample string 3</d2p1:ServiceType>
      <d2p1:SetupCost>1</d2p1:SetupCost>
      <d2p1:TotalBundleCredit>1</d2p1:TotalBundleCredit>
    </d2p1:InternetDetail>
    <d2p1:IsMoving>true</d2p1:IsMoving>
    <d2p1:MovingStatus>sample string 3</d2p1:MovingStatus>
    <d2p1:PresaleID>1</d2p1:PresaleID>
    <d2p1:SelectionStatus>true</d2p1:SelectionStatus>
    <d2p1:StateCode>sample string 4</d2p1:StateCode>
  </Value>
</ResultOfComparisonSelectionResult_S0_SH1S1i>