POST Api/TariffType/Fields

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TariffCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "TariffCode": "sample string 1"
}

application/xml, text/xml

Sample:

<ParamGetUsageFieldMapping xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewUsageFieldMappings.Parameters">
  <TariffCode>sample string 1</TariffCode>
</ParamGetUsageFieldMapping>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfUsageFieldMapping

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

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "ID": 1,
    "TariffTypeName": "sample string 2",
    "Peak": true,
    "OffPeak": true,
    "CL1": true,
    "CL2": true,
    "ClimateSaver": true,
    "Shoulder": true,
    "Notes": "sample string 9",
    "CLPeak": true,
    "CLOffPeak": true,
    "CLSolarSpunge": true,
    "LowDemandUsage": true,
    "HighDemandUsage": true,
    "TotalDemandUsage": true,
    "DailyDemandUsage": true,
    "DemandDays": true,
    "LowDemandDays": true,
    "HighDemandDays": true
  }
}

application/xml, text/xml

Sample:

<ResultOfUsageFieldMappingj5LqY284 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.NewUsageFieldMappings.Objects">
    <d2p1:CL1>true</d2p1:CL1>
    <d2p1:CL2>true</d2p1:CL2>
    <d2p1:CLOffPeak>true</d2p1:CLOffPeak>
    <d2p1:CLPeak>true</d2p1:CLPeak>
    <d2p1:CLSolarSpunge>true</d2p1:CLSolarSpunge>
    <d2p1:ClimateSaver>true</d2p1:ClimateSaver>
    <d2p1:DailyDemandUsage>true</d2p1:DailyDemandUsage>
    <d2p1:DemandDays>true</d2p1:DemandDays>
    <d2p1:HighDemandDays>true</d2p1:HighDemandDays>
    <d2p1:HighDemandUsage>true</d2p1:HighDemandUsage>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:LowDemandDays>true</d2p1:LowDemandDays>
    <d2p1:LowDemandUsage>true</d2p1:LowDemandUsage>
    <d2p1:Notes>sample string 9</d2p1:Notes>
    <d2p1:OffPeak>true</d2p1:OffPeak>
    <d2p1:Peak>true</d2p1:Peak>
    <d2p1:Shoulder>true</d2p1:Shoulder>
    <d2p1:TariffTypeName>sample string 2</d2p1:TariffTypeName>
    <d2p1:TotalDemandUsage>true</d2p1:TotalDemandUsage>
  </Value>
</ResultOfUsageFieldMappingj5LqY284>