POST Api/TariffCode/List

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Postcode	string	None.
Suburb	string	None.
NMI	string	None.
CustomerTypeID	integer	None.
IsSolar	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Postcode": "sample string 1",
  "Suburb": "sample string 2",
  "NMI": "sample string 3",
  "CustomerTypeID": 4,
  "IsSolar": true
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfListOfTariffCode

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": [
    {
      "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
    }
  ]
}

application/xml, text/xml

Sample:

<ResultOfArrayOfTariffCodecyEWbz0W 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: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>
  </Value>
</ResultOfArrayOfTariffCodecyEWbz0W>