GET api/ValueData/{id}?querytype={querytype}
Get Value information including Rates, Greenhouse Gas Emissions data, and Flex Alert Events
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
RateID |
string |
Required |
| querytype |
realtime,alldata |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
RateInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| RateID | string |
None. |
|
| SystemTime_UTC | string |
None. |
|
| RateName | string |
None. |
|
| RateType | string |
None. |
|
| Sector | string |
None. |
|
| API_Url | string |
None. |
|
| RatePlan_Url | string |
None. |
|
| EndUse | string |
None. |
|
| AltRateName1 | string |
None. |
|
| AltRateName2 | string |
None. |
|
| SignupCloseDate | string |
None. |
|
| ValueInformation | Collection of ValueData |
None. |
Response Formats
application/json, text/json
Sample:
{
"RateID": "sample string 1",
"SystemTime_UTC": "sample string 2",
"RateName": "sample string 3",
"RateType": "sample string 4",
"Sector": "sample string 5",
"API_Url": "sample string 6",
"RatePlan_Url": "sample string 7",
"EndUse": "sample string 8",
"AltRateName1": "sample string 9",
"AltRateName2": "sample string 10",
"SignupCloseDate": "sample string 11",
"ValueInformation": [
{
"ValueName": "sample string 1",
"DateStart": "sample string 2",
"DateEnd": "sample string 3",
"DayStart": "sample string 4",
"DayEnd": "sample string 5",
"TimeStart": "sample string 6",
"TimeEnd": "sample string 7",
"value": 8.0,
"Unit": "sample string 9"
},
{
"ValueName": "sample string 1",
"DateStart": "sample string 2",
"DateEnd": "sample string 3",
"DayStart": "sample string 4",
"DayEnd": "sample string 5",
"TimeStart": "sample string 6",
"TimeEnd": "sample string 7",
"value": 8.0,
"Unit": "sample string 9"
}
]
}
application/xml, text/xml
Sample:
<RateInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MIDAS_Api.Models">
<API_Url>sample string 6</API_Url>
<AltRateName1>sample string 9</AltRateName1>
<AltRateName2>sample string 10</AltRateName2>
<EndUse>sample string 8</EndUse>
<RateID>sample string 1</RateID>
<RateName>sample string 3</RateName>
<RatePlan_Url>sample string 7</RatePlan_Url>
<RateType>sample string 4</RateType>
<Sector>sample string 5</Sector>
<SignupCloseDate>sample string 11</SignupCloseDate>
<SystemTime_UTC>sample string 2</SystemTime_UTC>
<ValueInformation>
<ValueData>
<DateEnd>sample string 3</DateEnd>
<DateStart>sample string 2</DateStart>
<DayEnd>sample string 5</DayEnd>
<DayStart>sample string 4</DayStart>
<TimeEnd>sample string 7</TimeEnd>
<TimeStart>sample string 6</TimeStart>
<Unit>sample string 9</Unit>
<ValueName>sample string 1</ValueName>
<value>8</value>
</ValueData>
<ValueData>
<DateEnd>sample string 3</DateEnd>
<DateStart>sample string 2</DateStart>
<DayEnd>sample string 5</DayEnd>
<DayStart>sample string 4</DayStart>
<TimeEnd>sample string 7</TimeEnd>
<TimeStart>sample string 6</TimeStart>
<Unit>sample string 9</Unit>
<ValueName>sample string 1</ValueName>
<value>8</value>
</ValueData>
</ValueInformation>
</RateInformation>