GET Api/websites/plans?tariffType={tariffType}&distributorId={distributorId}&retailerId={retailerId}

Request Information

URI Parameters

Name	Type	Additional information
tariffType	string	Required
distributorId	integer	Required
retailerId	integer	Required

Body Parameters

None.

Response Information

Resource Description

ResultOfWP_PlansResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "Total": 1,
    "List": [
      {
        "PlanId": "sample string 1",
        "PlanName": "sample string 2",
        "HasUsageChargeDiscount": true,
        "HasSupplyChargeDiscount": true,
        "DiscountPercentage": 1.0
      },
      {
        "PlanId": "sample string 1",
        "PlanName": "sample string 2",
        "HasUsageChargeDiscount": true,
        "HasSupplyChargeDiscount": true,
        "DiscountPercentage": 1.0
      }
    ],
    "_Metadata": {
      "DistributorId": 1,
      "RetailerId": 2,
      "TariffType": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:

<ResultOfWP_PlansResponsel6fKDJY8 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.Websites.Returns">
    <d2p1:List>
      <d2p1:WP_PlansResponse.WP_PlanDetail>
        <d2p1:DiscountPercentage>1</d2p1:DiscountPercentage>
        <d2p1:HasSupplyChargeDiscount>true</d2p1:HasSupplyChargeDiscount>
        <d2p1:HasUsageChargeDiscount>true</d2p1:HasUsageChargeDiscount>
        <d2p1:PlanId>sample string 1</d2p1:PlanId>
        <d2p1:PlanName>sample string 2</d2p1:PlanName>
      </d2p1:WP_PlansResponse.WP_PlanDetail>
      <d2p1:WP_PlansResponse.WP_PlanDetail>
        <d2p1:DiscountPercentage>1</d2p1:DiscountPercentage>
        <d2p1:HasSupplyChargeDiscount>true</d2p1:HasSupplyChargeDiscount>
        <d2p1:HasUsageChargeDiscount>true</d2p1:HasUsageChargeDiscount>
        <d2p1:PlanId>sample string 1</d2p1:PlanId>
        <d2p1:PlanName>sample string 2</d2p1:PlanName>
      </d2p1:WP_PlansResponse.WP_PlanDetail>
    </d2p1:List>
    <d2p1:Total>1</d2p1:Total>
    <d2p1:_Metadata>
      <d2p1:DistributorId>1</d2p1:DistributorId>
      <d2p1:RetailerId>2</d2p1:RetailerId>
      <d2p1:TariffType>sample string 3</d2p1:TariffType>
    </d2p1:_Metadata>
  </Value>
</ResultOfWP_PlansResponsel6fKDJY8>