POST request/Tariffs/Tariff/Information

Gets additional information specific to a particular tariff.

Request Information

URI Parameters

None.

Body Parameters

The tariff information binding model.

Name	Description	Type	Additional information
TariffId		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "tariffId": 1
}

application/xml, text/xml

Sample:

<TariffInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <TariffId>1</TariffId>
</TariffInfoBindingModel>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffId"

1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

TariffInfoDtoResponse

Name	Type	Additional information
ApiVersion	string	None.
TariffInfoDto	TariffInfoDto	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "tariffInfoDto": {
    "supplierId": 1,
    "supplierName": "sample string 2",
    "supplierNameSimple": "sample string 3",
    "supplierDescription": "sample string 4",
    "tariffName": "sample string 5",
    "tariffDetails": [
      "sample string 1",
      "sample string 2"
    ],
    "rewardDetails": [
      "sample string 1",
      "sample string 2"
    ],
    "termsAndConditionsUrlDto": {
      "supplier": "sample string 1",
      "tariff": "sample string 2"
    },
    "isGreen": true,
    "isGreenCertified": true,
    "isPaper": true,
    "isFixed": true,
    "hasOnlineManagement": true,
    "hasPaperBilling": true,
    "hasRewardScheme": true,
    "hasWinterPremium": true,
    "isFixedbasedOnStartDate": true,
    "cancellationFeeDetail": "sample string 15",
    "hasCancellationFee": true,
    "isPartOfAGroupSwitch": true,
    "willExpireSoon": true,
    "hasWarmHomeDiscount": true
  }
}

application/xml, text/xml

Sample:

<TariffInfoDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <TariffInfoDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:CancellationFeeDetail>sample string 15</d2p1:CancellationFeeDetail>
    <d2p1:HasCancellationFee>true</d2p1:HasCancellationFee>
    <d2p1:HasOnlineManagement>true</d2p1:HasOnlineManagement>
    <d2p1:HasPaperBilling>true</d2p1:HasPaperBilling>
    <d2p1:HasRewardScheme>true</d2p1:HasRewardScheme>
    <d2p1:HasWarmHomeDiscount>true</d2p1:HasWarmHomeDiscount>
    <d2p1:HasWinterPremium>true</d2p1:HasWinterPremium>
    <d2p1:IsFixed>true</d2p1:IsFixed>
    <d2p1:IsFixedbasedOnStartDate>true</d2p1:IsFixedbasedOnStartDate>
    <d2p1:IsGreen>true</d2p1:IsGreen>
    <d2p1:IsGreenCertified>true</d2p1:IsGreenCertified>
    <d2p1:IsPaper>true</d2p1:IsPaper>
    <d2p1:IsPartOfAGroupSwitch>true</d2p1:IsPartOfAGroupSwitch>
    <d2p1:RewardDetails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:RewardDetails>
    <d2p1:SupplierDescription>sample string 4</d2p1:SupplierDescription>
    <d2p1:SupplierId>1</d2p1:SupplierId>
    <d2p1:SupplierName>sample string 2</d2p1:SupplierName>
    <d2p1:SupplierNameSimple>sample string 3</d2p1:SupplierNameSimple>
    <d2p1:TariffDetails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:TariffDetails>
    <d2p1:TariffName>sample string 5</d2p1:TariffName>
    <d2p1:TermsAndConditionsUrlDto>
      <d2p1:Supplier>sample string 1</d2p1:Supplier>
      <d2p1:Tariff>sample string 2</d2p1:Tariff>
    </d2p1:TermsAndConditionsUrlDto>
    <d2p1:WillExpireSoon>true</d2p1:WillExpireSoon>
  </TariffInfoDto>
  <Uri>sample string 2</Uri>
</TariffInfoDtoResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.SupplierId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.SupplierName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.SupplierNameSimple"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.SupplierDescription"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.TariffName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.TariffDetails[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.TariffDetails[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.RewardDetails[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.RewardDetails[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.TermsAndConditionsUrlDto.Supplier"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.TermsAndConditionsUrlDto.Tariff"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsGreen"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsGreenCertified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsPaper"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsFixed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasOnlineManagement"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasPaperBilling"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasRewardScheme"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasWinterPremium"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsFixedbasedOnStartDate"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.CancellationFeeDetail"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasCancellationFee"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.IsPartOfAGroupSwitch"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.WillExpireSoon"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffInfoDto.HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e--