GET Api/websites/TariffUsageMappings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "List": [
      {
        "TariffType": "sample string 1",
        "LongformTariffType": "sample string 2",
        "UsageMapping": {
          "HasPeak": true,
          "HasOffPeak": true,
          "HasCL1": true,
          "HasCL2": true,
          "HasShoulder": true
        }
      },
      {
        "TariffType": "sample string 1",
        "LongformTariffType": "sample string 2",
        "UsageMapping": {
          "HasPeak": true,
          "HasOffPeak": true,
          "HasCL1": true,
          "HasCL2": true,
          "HasShoulder": true
        }
      }
    ],
    "Total": 1
  }
}

application/xml, text/xml

Sample:

<ResultOfWP_TariffUsageMappingResponsel6fKDJY8 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_TariffUsageMappingResponse.WP_TariffResponse>
        <d2p1:LongformTariffType>sample string 2</d2p1:LongformTariffType>
        <d2p1:TariffType>sample string 1</d2p1:TariffType>
        <d2p1:UsageMapping>
          <d2p1:HasCL1>true</d2p1:HasCL1>
          <d2p1:HasCL2>true</d2p1:HasCL2>
          <d2p1:HasOffPeak>true</d2p1:HasOffPeak>
          <d2p1:HasPeak>true</d2p1:HasPeak>
          <d2p1:HasShoulder>true</d2p1:HasShoulder>
        </d2p1:UsageMapping>
      </d2p1:WP_TariffUsageMappingResponse.WP_TariffResponse>
      <d2p1:WP_TariffUsageMappingResponse.WP_TariffResponse>
        <d2p1:LongformTariffType>sample string 2</d2p1:LongformTariffType>
        <d2p1:TariffType>sample string 1</d2p1:TariffType>
        <d2p1:UsageMapping>
          <d2p1:HasCL1>true</d2p1:HasCL1>
          <d2p1:HasCL2>true</d2p1:HasCL2>
          <d2p1:HasOffPeak>true</d2p1:HasOffPeak>
          <d2p1:HasPeak>true</d2p1:HasPeak>
          <d2p1:HasShoulder>true</d2p1:HasShoulder>
        </d2p1:UsageMapping>
      </d2p1:WP_TariffUsageMappingResponse.WP_TariffResponse>
    </d2p1:List>
    <d2p1:Total>1</d2p1:Total>
  </Value>
</ResultOfWP_TariffUsageMappingResponsel6fKDJY8>