GET request/manage/tariff/{TariffId}

Request Information

URI Parameters

Name	Description	Type	Additional information
TariffId		integer	Required

Body Parameters

None.

Response Information

Resource Description

DisplayTariff

Name	Type	Additional information
ArcheType	string	None.
ArcheTypeId	integer	None.
HasWeekend	boolean	None.
Rates	Collection of DisplayRate	None.
Scenario	string	None.
ScenarioId	integer	None.
StandingCharge	decimal number	None.
TariffId	integer	None.
TariffName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "tariffId": 1,
  "tariffName": "sample string 2",
  "archeType": "sample string 3",
  "archeTypeId": 4,
  "scenario": "sample string 5",
  "scenarioId": 6,
  "hasWeekend": true,
  "standingCharge": 8.0,
  "rates": [
    {
      "displayName": "sample string 1",
      "importUnitRate": 2.0,
      "exportUnitRate": 3.0,
      "consumption": 4.0,
      "periodConfig": [
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2",
          "weekdayFromId": 3,
          "weekdayToId": 4,
          "weekdayFrom": "sample string 5",
          "weekdayTo": "sample string 6",
          "timeFrom": 7,
          "timeTo": 8
        },
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2",
          "weekdayFromId": 3,
          "weekdayToId": 4,
          "weekdayFrom": "sample string 5",
          "weekdayTo": "sample string 6",
          "timeFrom": 7,
          "timeTo": 8
        }
      ]
    },
    {
      "displayName": "sample string 1",
      "importUnitRate": 2.0,
      "exportUnitRate": 3.0,
      "consumption": 4.0,
      "periodConfig": [
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2",
          "weekdayFromId": 3,
          "weekdayToId": 4,
          "weekdayFrom": "sample string 5",
          "weekdayTo": "sample string 6",
          "timeFrom": 7,
          "timeTo": 8
        },
        {
          "startTime": "sample string 1",
          "endTime": "sample string 2",
          "weekdayFromId": 3,
          "weekdayToId": 4,
          "weekdayFrom": "sample string 5",
          "weekdayTo": "sample string 6",
          "timeFrom": 7,
          "timeTo": 8
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<DisplayTariff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
  <ArcheType>sample string 3</ArcheType>
  <ArcheTypeId>4</ArcheTypeId>
  <HasWeekend>true</HasWeekend>
  <Rates>
    <DisplayRate>
      <Consumption>4</Consumption>
      <DisplayName>sample string 1</DisplayName>
      <ExportUnitRate>3</ExportUnitRate>
      <ImportUnitRate>2</ImportUnitRate>
      <PeriodConfig>
        <TimeSlotConfig>
          <EndTime>sample string 2</EndTime>
          <StartTime>sample string 1</StartTime>
          <TimeFrom>7</TimeFrom>
          <TimeTo>8</TimeTo>
          <WeekdayFrom>sample string 5</WeekdayFrom>
          <WeekdayFromId>3</WeekdayFromId>
          <WeekdayTo>sample string 6</WeekdayTo>
          <WeekdayToId>4</WeekdayToId>
        </TimeSlotConfig>
        <TimeSlotConfig>
          <EndTime>sample string 2</EndTime>
          <StartTime>sample string 1</StartTime>
          <TimeFrom>7</TimeFrom>
          <TimeTo>8</TimeTo>
          <WeekdayFrom>sample string 5</WeekdayFrom>
          <WeekdayFromId>3</WeekdayFromId>
          <WeekdayTo>sample string 6</WeekdayTo>
          <WeekdayToId>4</WeekdayToId>
        </TimeSlotConfig>
      </PeriodConfig>
    </DisplayRate>
    <DisplayRate>
      <Consumption>4</Consumption>
      <DisplayName>sample string 1</DisplayName>
      <ExportUnitRate>3</ExportUnitRate>
      <ImportUnitRate>2</ImportUnitRate>
      <PeriodConfig>
        <TimeSlotConfig>
          <EndTime>sample string 2</EndTime>
          <StartTime>sample string 1</StartTime>
          <TimeFrom>7</TimeFrom>
          <TimeTo>8</TimeTo>
          <WeekdayFrom>sample string 5</WeekdayFrom>
          <WeekdayFromId>3</WeekdayFromId>
          <WeekdayTo>sample string 6</WeekdayTo>
          <WeekdayToId>4</WeekdayToId>
        </TimeSlotConfig>
        <TimeSlotConfig>
          <EndTime>sample string 2</EndTime>
          <StartTime>sample string 1</StartTime>
          <TimeFrom>7</TimeFrom>
          <TimeTo>8</TimeTo>
          <WeekdayFrom>sample string 5</WeekdayFrom>
          <WeekdayFromId>3</WeekdayFromId>
          <WeekdayTo>sample string 6</WeekdayTo>
          <WeekdayToId>4</WeekdayToId>
        </TimeSlotConfig>
      </PeriodConfig>
    </DisplayRate>
  </Rates>
  <Scenario>sample string 5</Scenario>
  <ScenarioId>6</ScenarioId>
  <StandingCharge>8</StandingCharge>
  <TariffId>1</TariffId>
  <TariffName>sample string 2</TariffName>
</DisplayTariff>

multipart/form-data

Sample:

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

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="TariffName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ArcheType"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ArcheTypeId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Scenario"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ScenarioId"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HasWeekend"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StandingCharge"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].DisplayName"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].ImportUnitRate"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].ExportUnitRate"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].Consumption"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].StartTime"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].EndTime"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].WeekdayFromId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].WeekdayToId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].WeekdayFrom"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].WeekdayTo"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].TimeFrom"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[0].TimeTo"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].StartTime"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].EndTime"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].WeekdayFromId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].WeekdayToId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].WeekdayFrom"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].WeekdayTo"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].TimeFrom"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[0].PeriodConfig[1].TimeTo"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].DisplayName"

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

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].ExportUnitRate"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].Consumption"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].StartTime"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].EndTime"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].WeekdayFromId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].WeekdayToId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].WeekdayFrom"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].WeekdayTo"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].TimeFrom"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[0].TimeTo"

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].StartTime"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].EndTime"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].WeekdayFromId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].WeekdayToId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].WeekdayFrom"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].WeekdayTo"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].TimeFrom"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Rates[1].PeriodConfig[1].TimeTo"

8
--MultipartDataMediaFormatterBoundary1q2w3e--