Function getRebate
Description
Returns all of the data for the rebate with the given ID.
Note: This function is only available to paid users.
Parameters
| Parameter |
Description |
Required |
| key |
Your API Key. Contact us to get one. |
Yes |
| function |
Function to execute (getRebate). |
Yes |
| id |
ID to Rebate. |
Yes |
| output |
Return results in XML or JSON (defaults to XML). |
No |
Sample Function Call
http://www.wattzon.com/api-function?key=<YOUR-API-KEY>&function=getRebate&id=2&output=XML
Function Results
| Parameter |
Description |
| request |
Request from client. |
| function |
Execution function. |
| id |
ID to request. |
| output |
Format data returned. |
| response |
Response from service. |
| code |
Status code of the result (see information below). |
| msg |
Further information about the result. |
| rebates |
List of rebates found. |
| rebate |
Rebate Found. |
| id |
ID to rebate. |
| category |
Category of rebate. |
| subCategory |
If found in subcategory rebate. |
| area |
Area of rebate. |
| name |
Name of rebate. |
| type |
Type of rebate. |
| amount |
Amount of rebate. |
| description |
Description of rebate. |
| provider |
Provider of rebate. |
| notes |
Notes about the rebate. |
Sample Function Response
<api>
<request>
<function>getRebate</function>
<id>384</id>
<output>xml</output>
</request>
<response>
<code>200</code>
<msg>OK</msg>
</response>
<rebates>
<rebate>
<id>2</id>
<category>Appliances</category>
<subCategory></subCategory>
<area>State of CA</area>
<name>Clothes Washer Rebate</name>
<provider>Pacific Gas & Electric</provider>
<type>Energy Utility</type>
<amount>
$50 on qualified, high-efficiency clothes
</amount>
<description>
High efficiency clothes washers
</description>
<notes>The rebate period began on Earth Day</notes>
</rebate>
</rebates>
</api>