POST Api/NMI/DistributorTariff/List

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NMI	string	None.
MIRN	string	None.
Postcode	string	None.
EnergyTypeID	integer	None.
CustomerTypeID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "NMI": "sample string 1",
  "MIRN": "sample string 2",
  "Postcode": "sample string 3",
  "EnergyTypeID": 4,
  "CustomerTypeID": 5
}

application/xml, text/xml

Sample:

<ParamGetAvailableDistributorTariffs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewTariffMappings.Parameters">
  <CustomerTypeID>5</CustomerTypeID>
  <EnergyTypeID>4</EnergyTypeID>
  <MIRN>sample string 2</MIRN>
  <NMI>sample string 1</NMI>
  <Postcode>sample string 3</Postcode>
</ParamGetAvailableDistributorTariffs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfDistributorTariffList

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "DistributorTariffDetails": [
      {
        "EnergyTypeID": 1,
        "DistributorID": "sample string 2",
        "DistributorName": "sample string 3",
        "TariffCodes": [
          {
            "TariffMappingID": 1,
            "TariffMappingCode": "sample string 2",
            "TariffType": "sample string 3",
            "DistributorName": "sample string 4",
            "IsRateAvailable": true
          },
          {
            "TariffMappingID": 1,
            "TariffMappingCode": "sample string 2",
            "TariffType": "sample string 3",
            "DistributorName": "sample string 4",
            "IsRateAvailable": true
          }
        ]
      },
      {
        "EnergyTypeID": 1,
        "DistributorID": "sample string 2",
        "DistributorName": "sample string 3",
        "TariffCodes": [
          {
            "TariffMappingID": 1,
            "TariffMappingCode": "sample string 2",
            "TariffType": "sample string 3",
            "DistributorName": "sample string 4",
            "IsRateAvailable": true
          },
          {
            "TariffMappingID": 1,
            "TariffMappingCode": "sample string 2",
            "TariffType": "sample string 3",
            "DistributorName": "sample string 4",
            "IsRateAvailable": true
          }
        ]
      }
    ],
    "TotalData": 1
  }
}

application/xml, text/xml

Sample:

<ResultOfDistributorTariffListcyEWbz0W 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.NewTariffMappings.Objects">
    <d2p1:DistributorTariffDetails>
      <d2p1:DistributorTariffDetail>
        <d2p1:DistributorID>sample string 2</d2p1:DistributorID>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:EnergyTypeID>1</d2p1:EnergyTypeID>
        <d2p1:TariffCodes>
          <d2p1:TariffCode>
            <d2p1:DistributorName>sample string 4</d2p1:DistributorName>
            <d2p1:IsRateAvailable>true</d2p1:IsRateAvailable>
            <d2p1:TariffMappingCode>sample string 2</d2p1:TariffMappingCode>
            <d2p1:TariffMappingID>1</d2p1:TariffMappingID>
            <d2p1:TariffType>sample string 3</d2p1:TariffType>
          </d2p1:TariffCode>
          <d2p1:TariffCode>
            <d2p1:DistributorName>sample string 4</d2p1:DistributorName>
            <d2p1:IsRateAvailable>true</d2p1:IsRateAvailable>
            <d2p1:TariffMappingCode>sample string 2</d2p1:TariffMappingCode>
            <d2p1:TariffMappingID>1</d2p1:TariffMappingID>
            <d2p1:TariffType>sample string 3</d2p1:TariffType>
          </d2p1:TariffCode>
        </d2p1:TariffCodes>
      </d2p1:DistributorTariffDetail>
      <d2p1:DistributorTariffDetail>
        <d2p1:DistributorID>sample string 2</d2p1:DistributorID>
        <d2p1:DistributorName>sample string 3</d2p1:DistributorName>
        <d2p1:EnergyTypeID>1</d2p1:EnergyTypeID>
        <d2p1:TariffCodes>
          <d2p1:TariffCode>
            <d2p1:DistributorName>sample string 4</d2p1:DistributorName>
            <d2p1:IsRateAvailable>true</d2p1:IsRateAvailable>
            <d2p1:TariffMappingCode>sample string 2</d2p1:TariffMappingCode>
            <d2p1:TariffMappingID>1</d2p1:TariffMappingID>
            <d2p1:TariffType>sample string 3</d2p1:TariffType>
          </d2p1:TariffCode>
          <d2p1:TariffCode>
            <d2p1:DistributorName>sample string 4</d2p1:DistributorName>
            <d2p1:IsRateAvailable>true</d2p1:IsRateAvailable>
            <d2p1:TariffMappingCode>sample string 2</d2p1:TariffMappingCode>
            <d2p1:TariffMappingID>1</d2p1:TariffMappingID>
            <d2p1:TariffType>sample string 3</d2p1:TariffType>
          </d2p1:TariffCode>
        </d2p1:TariffCodes>
      </d2p1:DistributorTariffDetail>
    </d2p1:DistributorTariffDetails>
    <d2p1:TotalData>1</d2p1:TotalData>
  </Value>
</ResultOfDistributorTariffListcyEWbz0W>