Rebate Bus

Rebate Bus

Rebate Bus makes utility energy efficiency incentives transparent, accessible, and vendor-neutral. Sync your product inventory to the DLC and Energy Star Qualified Products Lists, then use the Rebate Bus API to deliver data on locally available incentives.
Contact Info: mitch@rebatebus.com
Version: 2.0.1
BasePath:/RebateBus/RebateBus/2.0.1
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html

Access

  1. Become a Rebate Bus Pro Member
  2. Build your product inventory
  3. Generate your Rebate Bus Pro API Key

Methods

Table of Contents

Existingproduct

MidstreamApplication

Product

Program

Proposal

Rebate

Utility

Existingproduct

Up
put /existingproduct
Add a new existingproduct to proposal. User private API key. (createExistingProduct)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — ExistingProduct object that needs to be added to the proposal including proposal ID of the Proposal it will be added to

Return type

Example data

Content-Type: application/json
{
  "daysrun" : "",
  "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
  "rebate" : "",
  "lampcategory" : "aeiou",
  "hoursrun" : "",
  "proposalId" : "",
  "manufacturer" : "aeiou",
  "watts" : 1.3579000000000001069366817318950779736042022705078125,
  "modelnumber" : "aeiou",
  "productgroup" : "aeiou",
  "id" : 123456789,
  "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
  "replacement" : "",
  "age" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful ExistingProduct

400

Invalid ID supplied

404

Proposal not found

405

Validation exception

Up
delete /existingproduct/{id}
Deletes existing product. Uses private API key. (deleteExistingProduct)

Path parameters

id (required)
Path Parameter — Id of existingproduct to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this proposal

404

ExistingProduct not found

Up
get /existingproduct/{id}
Gets existing product. Uses private API key. (getExistingProduct)

Path parameters

id (required)
Path Parameter — Id of existingproduct to get

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "daysrun" : "",
  "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
  "rebate" : "",
  "lampcategory" : "aeiou",
  "hoursrun" : "",
  "proposalId" : "",
  "manufacturer" : "aeiou",
  "watts" : 1.3579000000000001069366817318950779736042022705078125,
  "modelnumber" : "aeiou",
  "productgroup" : "aeiou",
  "id" : 123456789,
  "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
  "replacement" : "",
  "age" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation ExistingProduct

400

Missing parameters

403

No write permission for this proposal

404

ExistingProduct not found

Up
get /existingproduct/{id}/rebates
Gets rebates which may be applicable to this existing product. Uses private API key. (getExistingProductRebates)

Path parameters

id (required)
Path Parameter — id of existing product

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Rebate]

Example data

Content-Type: application/json
[ {
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

missing parameters

403

operation not authorized

404

existingproduct not found

Up
post /existingproduct/{existingid}/replace/{newid}
Replaces an existingproduct. Uses private API key. (replaceExistingProduct)

Path parameters

existingid (required)
Path Parameter — Id of existingproduct to replace
newid (required)
Path Parameter — Id of product to replace with

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Form parameters

rebateid (optional)
Form Parameter — Id of the rebate to apply to the upgrade

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful

400

Invalid parameters

403

No authorization to access proposal

404

Product not found

Up
post /existingproduct/{id}
Update existingproduct in inventory. Uses private API key. (updateExistingProduct)

Path parameters

id (required)
Path Parameter — Id of existingproduct to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Updates to apply to the existingproduct

Return type

Example data

Content-Type: application/json
{
  "daysrun" : "",
  "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
  "rebate" : "",
  "lampcategory" : "aeiou",
  "hoursrun" : "",
  "proposalId" : "",
  "manufacturer" : "aeiou",
  "watts" : 1.3579000000000001069366817318950779736042022705078125,
  "modelnumber" : "aeiou",
  "productgroup" : "aeiou",
  "id" : 123456789,
  "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
  "replacement" : "",
  "age" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful ExistingProduct

404

ExistingProduct not found

MidstreamApplication

Up
post /verifymidstream
Verifies rebate applicability and available funds (verifyMidstream)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "zip" : 54023.0,
  "busid" : 435.0,
  "product" : 34.0,
  "amount" : 350.43,
  "cap" : 25.0,
  "maxamount" : 500.0,
  "program" : "Foo Rebate Program",
  "maxqty" : 10.0,
  "verification" : "Ei54abcd12FEfeic",
  "productStr" : "AL1917W"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

rebate verified inline_response_200_4

404

parameter not found inline_response_404

500

invalid paremeter inline_response_500

Product

Up
put /product
Add a new product to inventory. Uses private API key. (createProduct)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
  • application/json

Request body

body (required)
Body Parameter — Product object that needs to be added to the store

Return type

Example data

Content-Type: application/json
{
  "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
  "productcategory" : "aeiou",
  "distributorid" : "",
  "modelname" : "aeiou",
  "description" : "aeiou",
  "manufacturer" : "aeiou",
  "producttype" : "aeiou",
  "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
  "msrp" : 1.3579000000000001069366817318950779736042022705078125,
  "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
  "dlc" : true,
  "dlcproductid" : "aeiou",
  "id" : 123456789,
  "brand" : "aeiou",
  "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
  "gpm" : 1.3579000000000001069366817318950779736042022705078125,
  "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
  "estarid" : "aeiou",
  "listedlifetime" : "",
  "modelnumber" : "aeiou",
  "listedlightcolor" : "",
  "dimmingStatus" : "aeiou",
  "energystar" : true,
  "equivalentwatts" : "",
  "subcategory" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful Product

400

Invalid ID supplied

404

Pet not found

405

Validation exception

Up
delete /existingproduct/{id}
Deletes existing product. Uses private API key. (deleteExistingProduct)

Path parameters

id (required)
Path Parameter — Id of existingproduct to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this proposal

404

ExistingProduct not found

Up
delete /product/{id}
Deletes product. Uses private API key. (deleteProduct)

Path parameters

id (required)
Path Parameter — Id of product to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this proposal

404

Product not found

Up
get /product/{id}
Gets product. Uses private API key. (getProduct)

Path parameters

id (required)
Path Parameter — Id of product to get

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
  "productcategory" : "aeiou",
  "distributorid" : "",
  "modelname" : "aeiou",
  "description" : "aeiou",
  "manufacturer" : "aeiou",
  "producttype" : "aeiou",
  "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
  "msrp" : 1.3579000000000001069366817318950779736042022705078125,
  "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
  "dlc" : true,
  "dlcproductid" : "aeiou",
  "id" : 123456789,
  "brand" : "aeiou",
  "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
  "gpm" : 1.3579000000000001069366817318950779736042022705078125,
  "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
  "estarid" : "aeiou",
  "listedlifetime" : "",
  "modelnumber" : "aeiou",
  "listedlightcolor" : "",
  "dimmingStatus" : "aeiou",
  "energystar" : true,
  "equivalentwatts" : "",
  "subcategory" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Product

400

Missing parameters

403

No write permission for this proposal

404

Product not found

Up
get /rebate/{id}/products
Gets products qualifying for this rebate. Uses public API key. (getRebateProducts)

Path parameters

id (required)
Path Parameter — Id of rebate for which the products should qualify

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[#definitions/Product]

Example data

Content-Type: application/json
[ {
  "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
  "productcategory" : "aeiou",
  "distributorid" : "",
  "modelname" : "aeiou",
  "description" : "aeiou",
  "manufacturer" : "aeiou",
  "producttype" : "aeiou",
  "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
  "msrp" : 1.3579000000000001069366817318950779736042022705078125,
  "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
  "dlc" : true,
  "dlcproductid" : "aeiou",
  "id" : 123456789,
  "brand" : "aeiou",
  "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
  "gpm" : 1.3579000000000001069366817318950779736042022705078125,
  "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
  "estarid" : "aeiou",
  "listedlifetime" : "",
  "modelnumber" : "aeiou",
  "listedlightcolor" : "",
  "dimmingStatus" : "aeiou",
  "energystar" : true,
  "equivalentwatts" : "",
  "subcategory" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this rebate

404

Rebate not found

Up
post /existingproduct/{existingid}/replace/{newid}
Replaces an existingproduct. Uses private API key. (replaceExistingProduct)

Path parameters

existingid (required)
Path Parameter — Id of existingproduct to replace
newid (required)
Path Parameter — Id of product to replace with

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Form parameters

rebateid (optional)
Form Parameter — Id of the rebate to apply to the upgrade

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful

400

Invalid parameters

403

No authorization to access proposal

404

Product not found

Up
post /product/{id}
Update product in inventory. Uses private API key. (updateProduct)

Path parameters

id (required)
Path Parameter — Id of product to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Updates to apply to the product

Return type

Example data

Content-Type: application/json
{
  "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
  "productcategory" : "aeiou",
  "distributorid" : "",
  "modelname" : "aeiou",
  "description" : "aeiou",
  "manufacturer" : "aeiou",
  "producttype" : "aeiou",
  "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
  "msrp" : 1.3579000000000001069366817318950779736042022705078125,
  "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
  "dlc" : true,
  "dlcproductid" : "aeiou",
  "id" : 123456789,
  "brand" : "aeiou",
  "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
  "gpm" : 1.3579000000000001069366817318950779736042022705078125,
  "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
  "estarid" : "aeiou",
  "listedlifetime" : "",
  "modelnumber" : "aeiou",
  "listedlightcolor" : "",
  "dimmingStatus" : "aeiou",
  "energystar" : true,
  "equivalentwatts" : "",
  "subcategory" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful Product

404

Product not found

Program

Up
put /program/{id}/utility/{utilityid}
Adds a utility to a program. Uses private API key. (addProgramUtility)

Path parameters

id (required)
Path Parameter — Id of program to add a utility to
utilityid (required)
Path Parameter — Id of the utility that will be added

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

404

Program or utility not found

Up
put /program
Creates a new program. Uses private API key. (createProgram)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "commercial" : true,
  "multifamily" : true,
  "latitude" : 1.3579000000000001069366817318950779736042022705078125,
  "toc" : "aeiou",
  "newconstruction" : true,
  "cap" : "",
  "recaptcha" : true,
  "verifyutility" : true,
  "preapprovalrequired" : true,
  "contactphone" : "aeiou",
  "manageapprovals" : true,
  "longitude" : 1.3579000000000001069366817318950779736042022705078125,
  "budget" : 1.3579000000000001069366817318950779736042022705078125,
  "smallbusiness" : true,
  "requirements" : "aeiou",
  "address" : "aeiou",
  "test" : true,
  "verifyplace" : true,
  "postauditrequired" : true,
  "active" : true,
  "maxannualincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "home" : "aeiou",
  "limitqty" : 1.3579000000000001069366817318950779736042022705078125,
  "industrial" : true,
  "residential" : true,
  "limitamount" : 1.3579000000000001069366817318950779736042022705078125,
  "verifyqty" : true,
  "verifyamount" : true,
  "name" : "aeiou",
  "confirmtext" : "aeiou",
  "applicationlink" : "aeiou",
  "useutilitylogos" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful Program

400

Invalid parameters

Up
delete /program/{id}
Deletes program. Uses private API key. (deleteProgram)

Path parameters

id (required)
Path Parameter — Id of program to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this program

404

Program not found

Up
delete /program/{id}/utility/{utilityid}
Deletes a utility from a program. Uses private API key. (deleteProgramUtility)

Path parameters

id (required)
Path Parameter — Id of program to delete a utility from
utilityid (required)
Path Parameter — Id of utility to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

404

Program or utility not found

Up
get /program/all
Gets all programs. Uses public API key. (getAllPrograms)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Program]

Example data

Content-Type: application/json
[ {
  "contactemail" : "aeiou",
  "commercial" : true,
  "multifamily" : true,
  "latitude" : 1.3579000000000001069366817318950779736042022705078125,
  "toc" : "aeiou",
  "newconstruction" : true,
  "cap" : "",
  "recaptcha" : true,
  "verifyutility" : true,
  "preapprovalrequired" : true,
  "contactphone" : "aeiou",
  "manageapprovals" : true,
  "longitude" : 1.3579000000000001069366817318950779736042022705078125,
  "budget" : 1.3579000000000001069366817318950779736042022705078125,
  "smallbusiness" : true,
  "requirements" : "aeiou",
  "address" : "aeiou",
  "test" : true,
  "verifyplace" : true,
  "postauditrequired" : true,
  "active" : true,
  "maxannualincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "home" : "aeiou",
  "limitqty" : 1.3579000000000001069366817318950779736042022705078125,
  "industrial" : true,
  "residential" : true,
  "limitamount" : 1.3579000000000001069366817318950779736042022705078125,
  "verifyqty" : true,
  "verifyamount" : true,
  "name" : "aeiou",
  "confirmtext" : "aeiou",
  "applicationlink" : "aeiou",
  "useutilitylogos" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

Up
get /program/{id}
Gets program. Uses public API key. (getProgram)

Path parameters

id (required)
Path Parameter — Id of program to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "commercial" : true,
  "multifamily" : true,
  "latitude" : 1.3579000000000001069366817318950779736042022705078125,
  "toc" : "aeiou",
  "newconstruction" : true,
  "cap" : "",
  "recaptcha" : true,
  "verifyutility" : true,
  "preapprovalrequired" : true,
  "contactphone" : "aeiou",
  "manageapprovals" : true,
  "longitude" : 1.3579000000000001069366817318950779736042022705078125,
  "budget" : 1.3579000000000001069366817318950779736042022705078125,
  "smallbusiness" : true,
  "requirements" : "aeiou",
  "address" : "aeiou",
  "test" : true,
  "verifyplace" : true,
  "postauditrequired" : true,
  "active" : true,
  "maxannualincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "home" : "aeiou",
  "limitqty" : 1.3579000000000001069366817318950779736042022705078125,
  "industrial" : true,
  "residential" : true,
  "limitamount" : 1.3579000000000001069366817318950779736042022705078125,
  "verifyqty" : true,
  "verifyamount" : true,
  "name" : "aeiou",
  "confirmtext" : "aeiou",
  "applicationlink" : "aeiou",
  "useutilitylogos" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Program

400

Missing parameters

404

Program not found

Up
get /program/{id}/rebates
Gets program's rebates. Uses public API key. (getProgramRebates)

Path parameters

id (required)
Path Parameter — Id of program to get rebates for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Rebate]

Example data

Content-Type: application/json
[ {
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Program not found

Up
get /program/{id}/utilities
Gets program's eligible utilities. Uses public API key. (getProgramUtilities)

Path parameters

id (required)
Path Parameter — Id of program to get utilities for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Utility]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "state" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

404

Program not found

Up
post /program/{id}
Update program. Uses private API key. (updateProgram)

Path parameters

id (required)
Path Parameter — Id of program to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Updates to apply to the program

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "commercial" : true,
  "multifamily" : true,
  "latitude" : 1.3579000000000001069366817318950779736042022705078125,
  "toc" : "aeiou",
  "newconstruction" : true,
  "cap" : "",
  "recaptcha" : true,
  "verifyutility" : true,
  "preapprovalrequired" : true,
  "contactphone" : "aeiou",
  "manageapprovals" : true,
  "longitude" : 1.3579000000000001069366817318950779736042022705078125,
  "budget" : 1.3579000000000001069366817318950779736042022705078125,
  "smallbusiness" : true,
  "requirements" : "aeiou",
  "address" : "aeiou",
  "test" : true,
  "verifyplace" : true,
  "postauditrequired" : true,
  "active" : true,
  "maxannualincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "home" : "aeiou",
  "limitqty" : 1.3579000000000001069366817318950779736042022705078125,
  "industrial" : true,
  "residential" : true,
  "limitamount" : 1.3579000000000001069366817318950779736042022705078125,
  "verifyqty" : true,
  "verifyamount" : true,
  "name" : "aeiou",
  "confirmtext" : "aeiou",
  "applicationlink" : "aeiou",
  "useutilitylogos" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation Successful Program

403

No write permission for this program

404

Program not found

Proposal

Up
put /proposal
Create proposal. Uses private API key. (createProposal)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

proposal (required)
Body Parameter — Updates to apply to the product

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "installationestimate" : 1.3579000000000001069366817318950779736042022705078125,
  "city" : "aeiou",
  "description" : "aeiou",
  "utility" : "",
  "newconstruction" : true,
  "program" : "aeiou",
  "roi" : 1.3579000000000001069366817318950779736042022705078125,
  "products" : [ {
    "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
    "productcategory" : "aeiou",
    "distributorid" : "",
    "modelname" : "aeiou",
    "description" : "aeiou",
    "manufacturer" : "aeiou",
    "producttype" : "aeiou",
    "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
    "msrp" : 1.3579000000000001069366817318950779736042022705078125,
    "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
    "dlc" : true,
    "dlcproductid" : "aeiou",
    "id" : 123456789,
    "brand" : "aeiou",
    "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
    "gpm" : 1.3579000000000001069366817318950779736042022705078125,
    "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
    "estarid" : "aeiou",
    "listedlifetime" : "",
    "modelnumber" : "aeiou",
    "listedlightcolor" : "",
    "dimmingStatus" : "aeiou",
    "energystar" : true,
    "equivalentwatts" : "",
    "subcategory" : "aeiou"
  } ],
  "contactname" : "aeiou",
  "approved" : true,
  "rate" : "",
  "id" : 123456789,
  "contactphone" : "aeiou",
  "state" : "aeiou",
  "totalEnergySaved" : 1.3579000000000001069366817318950779736042022705078125,
  "maintenanceSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "programid" : "",
  "lpd" : 1.3579000000000001069366817318950779736042022705078125,
  "totalRebateAmount" : 1.3579000000000001069366817318950779736042022705078125,
  "address" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "existingproducts" : [ {
    "daysrun" : "",
    "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
    "rebate" : "",
    "lampcategory" : "aeiou",
    "hoursrun" : "",
    "proposalId" : "",
    "manufacturer" : "aeiou",
    "watts" : 1.3579000000000001069366817318950779736042022705078125,
    "modelnumber" : "aeiou",
    "productgroup" : "aeiou",
    "id" : 123456789,
    "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
    "replacement" : "",
    "age" : ""
  } ],
  "squarefeet" : "",
  "totalSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "userId" : 123456789,
  "submitted" : true,
  "totalInitialCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalNetCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalEnergySavedValue" : 1.3579000000000001069366817318950779736042022705078125,
  "currentEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125,
  "proposedEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful operation Proposal

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Up
delete /proposal/{id}
Deletes proposal. Uses private API key. (deleteProposal)

Path parameters

id (required)
Path Parameter — ID of the proposal to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Up
delete /proposal/{id}/share
Unshares proposal. Uses private API key. (deleteProposalShare)

Path parameters

id (required)
Path Parameter — ID of the proposal to unshare

Consumes

This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
  • application/json

Request body

shareemail (required)
Body Parameter — Email address to unshare proposal with

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Proposal unshared

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Up
get /proposal/{id}
Gets proposal. Uses private API key. (getProposal)

Path parameters

id (required)
Path Parameter — ID of the proposal to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "installationestimate" : 1.3579000000000001069366817318950779736042022705078125,
  "city" : "aeiou",
  "description" : "aeiou",
  "utility" : "",
  "newconstruction" : true,
  "program" : "aeiou",
  "roi" : 1.3579000000000001069366817318950779736042022705078125,
  "products" : [ {
    "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
    "productcategory" : "aeiou",
    "distributorid" : "",
    "modelname" : "aeiou",
    "description" : "aeiou",
    "manufacturer" : "aeiou",
    "producttype" : "aeiou",
    "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
    "msrp" : 1.3579000000000001069366817318950779736042022705078125,
    "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
    "dlc" : true,
    "dlcproductid" : "aeiou",
    "id" : 123456789,
    "brand" : "aeiou",
    "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
    "gpm" : 1.3579000000000001069366817318950779736042022705078125,
    "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
    "estarid" : "aeiou",
    "listedlifetime" : "",
    "modelnumber" : "aeiou",
    "listedlightcolor" : "",
    "dimmingStatus" : "aeiou",
    "energystar" : true,
    "equivalentwatts" : "",
    "subcategory" : "aeiou"
  } ],
  "contactname" : "aeiou",
  "approved" : true,
  "rate" : "",
  "energySavings" : [ {
    "replacementname" : "aeiou",
    "energySaved" : 1234.5,
    "rebateAmount" : 10.0,
    "rebate" : {
      "dlcpremiumonly" : true,
      "amount" : 1.3579000000000001069366817318950779736042022705078125,
      "code" : "aeiou",
      "rebatetype" : "aeiou",
      "created" : "2000-01-23T04:56:07.000+00:00",
      "minwattssaved" : "aeiou",
      "replace" : true,
      "applicationpage" : "",
      "program" : "aeiou",
      "replacementrequirement" : "aeiou",
      "newwattage" : "aeiou",
      "midstream" : true,
      "existingwattage" : "aeiou",
      "unit" : "aeiou",
      "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
      "retrofit" : true,
      "operatinghours" : "aeiou",
      "newlumens" : "aeiou",
      "name" : "aeiou",
      "energystar" : true,
      "dlc" : true,
      "newefficacy" : "aeiou"
    },
    "existingname" : "aeiou",
    "rebatePerFixture" : "5.00",
    "dollarsSaved" : 123.45,
    "numfixtures" : 2
  } ],
  "id" : 123456789,
  "contactphone" : "aeiou",
  "state" : "aeiou",
  "totalEnergySaved" : 1.3579000000000001069366817318950779736042022705078125,
  "maintenanceSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "programid" : "",
  "lpd" : 1.3579000000000001069366817318950779736042022705078125,
  "totalRebateAmount" : 1.3579000000000001069366817318950779736042022705078125,
  "address" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "existingproducts" : [ {
    "daysrun" : "",
    "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
    "rebate" : "",
    "lampcategory" : "aeiou",
    "hoursrun" : "",
    "proposalId" : "",
    "manufacturer" : "aeiou",
    "watts" : 1.3579000000000001069366817318950779736042022705078125,
    "modelnumber" : "aeiou",
    "productgroup" : "aeiou",
    "id" : 123456789,
    "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
    "replacement" : "",
    "age" : ""
  } ],
  "squarefeet" : "",
  "totalSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "userId" : 123456789,
  "submitted" : true,
  "totalInitialCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalNetCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalEnergySavedValue" : 1.3579000000000001069366817318950779736042022705078125,
  "currentEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125,
  "proposedEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation. includes savings calculations and associated products/existingproducts/rebates in `energySavings` inline_response_200

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Up
get /proposal/{id}/shares
Gets list of shared-with emails. Uses private API key. (proposalShares)

Path parameters

id (required)
Path Parameter — ID of the proposal to get shares for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
[ {
  "email" : "foo@example.com"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Opersation successful

404

Proposal not found

Up
post /proposal/{id}/share
Shares proposal. Uses private API key. (shareProposal)

Path parameters

id (required)
Path Parameter — ID of the proposal to share

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

shareemail (required)
Body Parameter — Email address to share proposal with

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Proposal Shared

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Up
post /proposal/{id}
Update proposal. Uses private API key. (updateProposal)

Path parameters

id (required)
Path Parameter — ID of the proposal to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

proposal (required)
Body Parameter — Updates to apply to the product

Return type

Example data

Content-Type: application/json
{
  "contactemail" : "aeiou",
  "installationestimate" : 1.3579000000000001069366817318950779736042022705078125,
  "city" : "aeiou",
  "description" : "aeiou",
  "utility" : "",
  "newconstruction" : true,
  "program" : "aeiou",
  "roi" : 1.3579000000000001069366817318950779736042022705078125,
  "products" : [ {
    "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
    "productcategory" : "aeiou",
    "distributorid" : "",
    "modelname" : "aeiou",
    "description" : "aeiou",
    "manufacturer" : "aeiou",
    "producttype" : "aeiou",
    "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
    "msrp" : 1.3579000000000001069366817318950779736042022705078125,
    "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
    "dlc" : true,
    "dlcproductid" : "aeiou",
    "id" : 123456789,
    "brand" : "aeiou",
    "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
    "gpm" : 1.3579000000000001069366817318950779736042022705078125,
    "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
    "estarid" : "aeiou",
    "listedlifetime" : "",
    "modelnumber" : "aeiou",
    "listedlightcolor" : "",
    "dimmingStatus" : "aeiou",
    "energystar" : true,
    "equivalentwatts" : "",
    "subcategory" : "aeiou"
  } ],
  "contactname" : "aeiou",
  "approved" : true,
  "rate" : "",
  "id" : 123456789,
  "contactphone" : "aeiou",
  "state" : "aeiou",
  "totalEnergySaved" : 1.3579000000000001069366817318950779736042022705078125,
  "maintenanceSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "programid" : "",
  "lpd" : 1.3579000000000001069366817318950779736042022705078125,
  "totalRebateAmount" : 1.3579000000000001069366817318950779736042022705078125,
  "address" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "existingproducts" : [ {
    "daysrun" : "",
    "remaininglife" : 1.3579000000000001069366817318950779736042022705078125,
    "rebate" : "",
    "lampcategory" : "aeiou",
    "hoursrun" : "",
    "proposalId" : "",
    "manufacturer" : "aeiou",
    "watts" : 1.3579000000000001069366817318950779736042022705078125,
    "modelnumber" : "aeiou",
    "productgroup" : "aeiou",
    "id" : 123456789,
    "maintenance" : 1.3579000000000001069366817318950779736042022705078125,
    "replacement" : "",
    "age" : ""
  } ],
  "squarefeet" : "",
  "totalSavings" : 1.3579000000000001069366817318950779736042022705078125,
  "userId" : 123456789,
  "submitted" : true,
  "totalInitialCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalNetCost" : 1.3579000000000001069366817318950779736042022705078125,
  "totalEnergySavedValue" : 1.3579000000000001069366817318950779736042022705078125,
  "currentEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125,
  "proposedEnergyUsage" : 1.3579000000000001069366817318950779736042022705078125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful operation Proposal

400

Missing parameters

403

No write permission for this proposal

404

Proposal not found

Rebate

Up
put /rebate
Creates a new rebate. Uses private API key. (createRebate)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter

Return type

#definitions/Rebate

Example data

Content-Type: application/json
{
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful #definitions/Rebate

400

Invalid parameters

Up
delete /rebate/{id}
Deletes rebate. Uses private API key. (deleteRebate)

Path parameters

id (required)
Path Parameter — Id of rebate to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this rebate

404

Rebate not found

Up
get /existingproduct/{id}/rebates
Gets rebates which may be applicable to this existing product. Uses private API key. (getExistingProductRebates)

Path parameters

id (required)
Path Parameter — id of existing product

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Rebate]

Example data

Content-Type: application/json
[ {
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

missing parameters

403

operation not authorized

404

existingproduct not found

Up
get /program/{id}/rebates
Gets program's rebates. Uses public API key. (getProgramRebates)

Path parameters

id (required)
Path Parameter — Id of program to get rebates for

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[Rebate]

Example data

Content-Type: application/json
[ {
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

404

Program not found

Up
get /rebate/{id}
Gets rebate. Uses public API key. (getRebate)

Path parameters

id (required)
Path Parameter — Id of rebate to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation Rebate

400

Missing parameters

403

No write permission for this rebate

404

Rebate not found

Up
get /rebate/{id}/products
Gets products qualifying for this rebate. Uses public API key. (getRebateProducts)

Path parameters

id (required)
Path Parameter — Id of rebate for which the products should qualify

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

array[#definitions/Product]

Example data

Content-Type: application/json
[ {
  "luminairelength" : 1.3579000000000001069366817318950779736042022705078125,
  "productcategory" : "aeiou",
  "distributorid" : "",
  "modelname" : "aeiou",
  "description" : "aeiou",
  "manufacturer" : "aeiou",
  "producttype" : "aeiou",
  "beamangle" : 1.3579000000000001069366817318950779736042022705078125,
  "msrp" : 1.3579000000000001069366817318950779736042022705078125,
  "listedwatts" : 1.3579000000000001069366817318950779736042022705078125,
  "dlc" : true,
  "dlcproductid" : "aeiou",
  "id" : 123456789,
  "brand" : "aeiou",
  "listedlightoutput" : 1.3579000000000001069366817318950779736042022705078125,
  "gpm" : 1.3579000000000001069366817318950779736042022705078125,
  "listedlumensperwatt" : 1.3579000000000001069366817318950779736042022705078125,
  "estarid" : "aeiou",
  "listedlifetime" : "",
  "modelnumber" : "aeiou",
  "listedlightcolor" : "",
  "dimmingStatus" : "aeiou",
  "energystar" : true,
  "equivalentwatts" : "",
  "subcategory" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this rebate

404

Rebate not found

Up
post /existingproduct/{existingid}/replace/{newid}
Replaces an existingproduct. Uses private API key. (replaceExistingProduct)

Path parameters

existingid (required)
Path Parameter — Id of existingproduct to replace
newid (required)
Path Parameter — Id of product to replace with

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Form parameters

rebateid (optional)
Form Parameter — Id of the rebate to apply to the upgrade

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful

400

Invalid parameters

403

No authorization to access proposal

404

Product not found

Up
post /rebate/{id}
Update rebate. Uses private API key. (updateRebate)

Path parameters

id (required)
Path Parameter — Id of rebate to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Updates to apply to the rebate

Return type

#definitions/Rebate

Example data

Content-Type: application/json
{
  "dlcpremiumonly" : true,
  "amount" : 1.3579000000000001069366817318950779736042022705078125,
  "code" : "aeiou",
  "rebatetype" : "aeiou",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "minwattssaved" : "aeiou",
  "replace" : true,
  "applicationpage" : "",
  "program" : "aeiou",
  "replacementrequirement" : "aeiou",
  "newwattage" : "aeiou",
  "midstream" : true,
  "existingwattage" : "aeiou",
  "unit" : "aeiou",
  "dlcpremiumincentive" : 1.3579000000000001069366817318950779736042022705078125,
  "retrofit" : true,
  "operatinghours" : "aeiou",
  "newlumens" : "aeiou",
  "name" : "aeiou",
  "energystar" : true,
  "dlc" : true,
  "newefficacy" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful #definitions/Rebate

403

No write permission for the program containing the rebate

404

Rebate not found

Utility

Up
put /program/{id}/utility/{utilityid}
Adds a utility to a program. Uses private API key. (addProgramUtility)

Path parameters

id (required)
Path Parameter — Id of program to add a utility to
utilityid (required)
Path Parameter — Id of the utility that will be added

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

404

Program or utility not found

Up
put /utility/{id}/zip
Add a utility zip. Uses private API key. (addUtilityZip)

Path parameters

id (required)
Path Parameter — Id of utility to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Zipcode to be associated with a Utility

Return type

Example data

Content-Type: application/json
{
  "zip" : 63034.0,
  "utilityid" : 4.0,
  "id" : 1.0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful inline_response_200_3

400

Missing required parameters

403

No programadmin permission

404

Utility not found

Up
put /utility
Creates a new utility. Uses private API key. (createUtility)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter

Return type

#definitions/Utility

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "state" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation Successful #definitions/Utility

400

Invalid parameters

Up
delete /program/{id}/utility/{utilityid}
Deletes a utility from a program. Uses private API key. (deleteProgramUtility)

Path parameters

id (required)
Path Parameter — Id of program to delete a utility from
utilityid (required)
Path Parameter — Id of utility to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

404

Program or utility not found

Up
delete /utility/{id}
Deletes utility. Uses private API key. (deleteUtility)

Path parameters

id (required)
Path Parameter — Id of utility to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing parameters

403

No write permission for this utility

404

Utility not found

Up
delete /utility/{id}/zip/{zipid}
Deletes utility zip. Uses private API key. (deleteUtilityZip)

Path parameters

zipid (required)
Path Parameter — Id of zip to delete
id (required)
Path Parameter — Id of utility to delete

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

400

Missing required parameters

403

No programadmin permission

404

Utility zip not found

Up
get /utility/all
Gets all utilities. Uses public API key. (getAllUtilities)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
[ {
  "UtilityZips" : [ {
    "zip" : 63034,
    "utilityid" : 1,
    "latitude" : 34.940250393,
    "id" : 4,
    "utilityname" : "Test Utility",
    "longitude" : -81.35623412
  } ],
  "name" : "Test Utility",
  "id" : 1,
  "state" : "Missouri"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation

Up
get /utility/{id}
Gets utility. Uses public API key. (getUtility)

Path parameters

id (required)
Path Parameter — Id of utility to get

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "UtilityZips" : [ {
    "zip" : 63034,
    "utilityid" : 1,
    "latitude" : 34.940250393,
    "id" : 4,
    "utilityname" : "Test Utility",
    "longitude" : -81.35623412
  } ],
  "name" : "Test Utility",
  "id" : 1,
  "state" : "Missouri"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

successful operation inline_response_200_2

400

Missing parameters

403

No write permission for this utility

404

Utility not found

Up
post /utility/{id}
Update utility. Uses private API key. (updateUtility)

Path parameters

id (required)
Path Parameter — Id of utility to update

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json
  • multipart/form-data

Request body

body (required)
Body Parameter — Updates to apply to the utility

Return type

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "state" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Operation successful Utility

403

No write permission for the utility

404

Utility not found

Models

[ Jump to Methods ]

Table of Contents

  1. body
  2. body_1
  3. ExistingProduct
  4. inline_response_200
  5. inline_response_200_1
  6. inline_response_200_2
  7. inline_response_200_2_UtilityZips
  8. inline_response_200_3
  9. inline_response_200_4
  10. inline_response_200_energySavings
  11. inline_response_404
  12. inline_response_500
  13. MidstreamApplicaion
  14. Product
  15. Program
  16. Proposal
  17. Rebate
  18. Utility

body - Up

zip (optional)
utilityid (optional)
utility_name (optional)

body_1 - Up

rebateid (optional)
productid (optional)
zip (optional)
propertytype (optional)

ExistingProduct - Up

id (optional)
Long format: int64
manufacturer (optional)
String manufacturer of the product (optional)
modelnumber (optional)
String modelnumber of the product (user specified name)
watts (optional)
BigDecimal power consumption, in watts
daysrun (optional)
Integer days that the product operates per year
hoursrun (optional)
Integer hours per day that the product operates
proposalId (optional)
Integer id of the proposal that the existing product is part of
maintenance (optional)
BigDecimal annual maintenance cost of the product (optional)
age (optional)
Integer age, in years, of the product (optional)
remaininglife (optional)
BigDecimal estimated remaining life of the product (optional)
productgroup (optional)
String name of the group or area in which the product is installed. used to organize the project visually - a placeholder can be used for API usage
replacement (optional)
Integer id of the Product which is replacing this ExistingProduct
rebate (optional)
Integer id of the Rebate applied to this replacement
lampcategory (optional)
String if product category is one of the following - Fluorescent Display Case, Fluorescent Stairwell and Passageway, 1X4 Fluorescent Troffer, 2X4 Fluorescent Troffer, 2X2 Fluorescent Troffer, Fluorescent Strip Fixture, Fluorescent Vapor Tight, Fluorescent High-Bay, Fluorescent Low-Bay lampcategory should be one of the following, Fluorescent T5 Lamp, Fluorescent T8 Lamp, Fluorescent T12 Lamp This ensures that we'll get the right local rebate, whether its based on lamps or whole fixtures.

inline_response_200 - Up

id (optional)
Long format: int64
currentEnergyUsage (optional)
proposedEnergyUsage (optional)
totalInitialCost (optional)
totalNetCost (optional)
totalEnergySaved (optional)
totalEnergySavedValue (optional)
totalSavings (optional)
roi (optional)
totalRebateAmount (optional)
maintenanceSavings (optional)
userId (optional)
Long format: int64
created (optional)
Date format: date-time
contactname (optional)
String contact name for the proposed project
contactphone (optional)
String contact number for the proposed project
contactemail (optional)
String contact email for the proposed project.
rate (optional)
Integer electricity rate, in cents, at project site
existingproducts (optional)
products (optional)
installationestimate (optional)
BigDecimal estimate of installation cost
state (optional)
String any two-letter state or province code (e.g., NJ for New Jersey, BC for British Columbia)
city (optional)
String city where site is located
description (optional)
String description of the project
address (optional)
String address where project is located
utility (optional)
Integer utility serving project address, references Utility.id
program (optional)
String name of rebate program associated with the proposal. denormalized from Program name
programid (optional)
Integer program associated with the proposal. references Program.id
lpd (optional)
BigDecimal lighting power density associated with the project site. recommend using the ASHRAE standards, https://www.dpandl.com/images/uploads/ASHRAETable9_6_1.pdf
newconstruction (optional)
Boolean proposal is/is not for new construction. affects program eligiblity.
submitted (optional)
Boolean has proposal been submitted to the program?
approved (optional)
Boolean has proposal been approved by the program?
squarefeet (optional)
Integer area, in square feet, of the project site.
energySavings (optional)

inline_response_200_2 - Up

id (optional)
name (optional)
state (optional)
UtilityZips (optional)
array[inline_response_200_2_UtilityZips] Array of zips assigned to a given utility

inline_response_200_2_UtilityZips - Up

id (optional)
zip (optional)
utilityname (optional)
utilityid (optional)
latitude (optional)
longitude (optional)

inline_response_200_3 - Up

id (optional)
zip (optional)
utilityid (optional)

inline_response_200_4 - Up

verification (optional)
product (optional)
amount (optional)
maxqty (optional)
zip (optional)
productStr (optional)
program (optional)
maxamount (optional)
busid (optional)
cap (optional)

inline_response_200_energySavings - Up

numfixtures (optional)
existingname (optional)
replacementname (optional)
energySaved (optional)
dollarsSaved (optional)
rebate (optional)
rebateAmount (optional)
rebatePerFixture (optional)

MidstreamApplicaion - Up

productid (optional)
Integer id of the product for which the midstream rebate is requested
rebateid (optional)
Integer id of the midstream rebate being applied for
answers (optional)
String semicolon-delimited answers to questions
amount (optional)
BigDecimal incentive amount in USD for each product
quantity (optional)
BigDecimal number of products purchased
address (optional)
String shipping address of the purchase
billaddress (optional)
String billing address of the purchase
installaddress (optional)
String user-specified address where products are to be installed
googleplaceid (optional)
String place ID of installaddress, per Google Places
contactname (optional)
String name of the customer purchasing the products
contactemail (optional)
String email address of the customer
contactphone (optional)
String phone number of the customer
utility (optional)
Integer id of the utility serving installaddress
zip (optional)
Integer zip code to which products are being shipped
installzip (optional)
Integer zip code of installaddress
billzip (optional)
Integer zip code of billaddress
approved (optional)
Boolean flag indiciating whether final approval has been issued for this application
cookie (optional)
String tracking cookie associated with the purchase
verification (optional)
String verification code associated with the purchase
limitpurchases (optional)
String comma-delimited list of associated previous purchases, tracked by verification code. associations are determined by the policies set in Program.
limitamount (optional)
BigDecimal dollar value of purchases in limitpurchases - shows customer's previous incentive history within the limiting period as a dollar value
limitqty (optional)
Integer number of products in limitpurchases - shows customer's previous product purchase quantity within the limiting period
timestamp (optional)
date time when the verification code was issued. format: date

Product - Up

id (optional)
Long format: int64
dlc (optional)
dlcproductid (optional)
String id of this product on the DLC QPL, if qualified
energystar (optional)
estarid (optional)
String id of this product on the Energy Star QPL, if qualified
manufacturer (optional)
String manufacturer of the product
brand (optional)
String brand of the product, corresponds to brand field on estar qpl
distributorid (optional)
Integer id of the distributor inventory with which the product is associated. if 0, part of the public products list. if nonzero, must have the proper credentials to access the product.
modelnumber (optional)
String modelnumber of the product
modelname (optional)
String more detailed name - associated with the field of the same name on the Energy Star and Watersense QPLs.
listedlightoutput (optional)
BigDecimal light output, in lumens
listedwatts (optional)
BigDecimal power consumption, in watts
equivalentwatts (optional)
Integer estimated wattage of inefficient products that this product replaces
listedlumensperwatt (optional)
BigDecimal efficacy, in lumens per watt, of the product
listedlightcolor (optional)
Integer color of the light, in degrees Kelvin
listedlifetime (optional)
Integer time, in hours, that the product is tested to operate for
gpm (optional)
BigDecimal gallons per minute, for Watersense products only
msrp (optional)
BigDecimal retail cost of item, at end consumer pricing
luminairelength (optional)
BigDecimal length, in feet, of the product. only relevant for linear lighting products.
beamangle (optional)
dimmingStatus (optional)
description (optional)
producttype (optional)
String type of product. must match up with one of the QPLs. for watersense showerheads, must be 'Watersense Showerheads'
productcategory (optional)
String category of product. must match up with one of the QPLs. for watersense showerheads, must be 'Watersense Showerheads'
subcategory (optional)
String subcategory, gives additional detail not captured by productcategory. no restrictions on its value.

Program - Up

name (optional)
String name of the program
active (optional)
Boolean whether the program is currently accepting applications
test (optional)
Boolean whether the program is in testing mode
cap (optional)
Integer maximum percentage of the base product cost (msrp) which the program will pay
manageapprovals (optional)
Boolean whether the program enforces product preapproval for midstream incentives
recaptcha (optional)
Boolean whether the program requires recaptcha for midstream incentives
verifyplace (optional)
Boolean whether the program requires incentive limits to be enforced on shipping addresses
verifyqty (optional)
Boolean whether the program requires product quantity limits per customer for midstreams
verifyamount (optional)
Boolean whether the program requires incentive amount limits per customer for midstreams
verifyutility (optional)
Boolean whether the program requires the user to confirm their local utility
toc (optional)
String terms and conditions link URL for midstream incentives
confirmtext (optional)
String text which users must agree to in order to get an incentive
limitqty (optional)
BigDecimal if verifyqty is true, this limit is enforced
limitamount (optional)
BigDecimal if verifyamount is true, this limit is enforced
useutilitylogos (optional)
Boolean if true, use utility logos instead of program logos for midstream programs
home (optional)
String URL of the program's home page
address (optional)
String address of the program
latitude (optional)
BigDecimal latitude of the program's center (for geolocation of rebatebus.com visitors)
longitude (optional)
BigDecimal longitude of the program's center (for geolocation of rebatebus.com visitors)
applicationlink (optional)
String if applicable, a link to the necessary forms or web application to apply
budget (optional)
BigDecimal for midstream programs, the current remaining program funding limit
contactemail (optional)
String email address point of contact for the program
contactphone (optional)
String phone number point of contact for the program
requirements (optional)
String program requirements text description
preapprovalrequired (optional)
Boolean if true, proposals must be submitted to the program and approved before the project is done
postauditrequired (optional)
Boolean if true, the program will inspect projects that get incentives
maxannualincentive (optional)
BigDecimal maximum annual incentive dollar limit (for informational purposes, not midstream programs)
commercial (optional)
Boolean if true, commercial properties are eligible for the program
residential (optional)
Boolean if true, residential properties are eligible for the program
smallbusiness (optional)
Boolean if true, small business properties are eligible for the program
industrial (optional)
Boolean if true, industrial properties are eligible for the program
multifamily (optional)
Boolean if true, multifamily properties are eligible for the program
newconstruction (optional)
Boolean if true, new construction properties are eligible for the program

Proposal - Up

id (optional)
Long format: int64
currentEnergyUsage (optional)
proposedEnergyUsage (optional)
totalInitialCost (optional)
totalNetCost (optional)
totalEnergySaved (optional)
totalEnergySavedValue (optional)
totalSavings (optional)
roi (optional)
totalRebateAmount (optional)
maintenanceSavings (optional)
userId (optional)
Long format: int64
created (optional)
Date format: date-time
contactname (optional)
String contact name for the proposed project
contactphone (optional)
String contact number for the proposed project
contactemail (optional)
String contact email for the proposed project.
rate (optional)
Integer electricity rate, in cents, at project site
existingproducts (optional)
products (optional)
installationestimate (optional)
BigDecimal estimate of installation cost
state (optional)
String any two-letter state or province code (e.g., NJ for New Jersey, BC for British Columbia)
city (optional)
String city where site is located
description (optional)
String description of the project
address (optional)
String address where project is located
utility (optional)
Integer utility serving project address, references Utility.id
program (optional)
String name of rebate program associated with the proposal. denormalized from Program name
programid (optional)
Integer program associated with the proposal. references Program.id
lpd (optional)
BigDecimal lighting power density associated with the project site. recommend using the ASHRAE standards, https://www.dpandl.com/images/uploads/ASHRAETable9_6_1.pdf
newconstruction (optional)
Boolean proposal is/is not for new construction. affects program eligiblity.
submitted (optional)
Boolean has proposal been submitted to the program?
approved (optional)
Boolean has proposal been approved by the program?
squarefeet (optional)
Integer area, in square feet, of the project site.

Rebate - Up

name (optional)
String name of the rebate, drawn from a static library
program (optional)
String references a Program that this rebate is a part of
replacementrequirement (optional)
String text description of additional requirements stipulated by this rebate
code (optional)
String code associated with the rebate
applicationpage (optional)
Integer if this rebate references a publicly available form, applicationpage contains the page number its on
existingwattage (optional)
String formatted string description of the existing product wattage requirements of the incentive
minwattssaved (optional)
String formatted string description of the minimum watts saved requirements of the incentive
operatinghours (optional)
String formatted string description of the operating hours requirements of the incentive
newwattage (optional)
String formatted string description of the new product wattage requirements of the incentive
newlumens (optional)
String formatted string description of the new product luminosity requirements of the incentive
newefficacy (optional)
String formatted string description of the new product efficacy requirements of the incentive
rebatetype (optional)
String one of Prescriptive or Custom. describes the metric by which amount is paid
Enum:
Prescriptive
Custom
amount (optional)
BigDecimal amount, in USD, paid per unit
unit (optional)
String unit by which 'amount' is paid.
Enum:
Fixture
Lamp
Linear Foot
Door
Head
Kilolumen
kw (Kilowatts Saved)
kwh (Kilowatt-Hours Saved)
w (Watts Saved)
percent (% Wattage Reduction)
midstream (optional)
Boolean flag indicating availability of the incentive via API
energystar (optional)
Boolean flag indiciating whether Energy Star is a requirement. If dlc and energystar, either is acceptable.
dlc (optional)
Boolean flag indiciating whether DLC is a requirement. If dlc and energystar, either is acceptable.
dlcpremiumonly (optional)
Boolean flag indicating whether DLC premium is a requirement, iff dlc is true
dlcpremiumincentive (optional)
BigDecimal special incentive for DLC premium products. overwrites the amount field in calculations if dlcpremium is applied to the product
replace (optional)
Boolean flag indicating whether full-fixture replacements are eligible
retrofit (optional)
Boolean flag indicating whether retrofits are eligible
created (optional)
date creation/update date for the rebate format: date

Utility - Up

name (optional)
String name of the utility
state (optional)
String name of the state where utility is located

Rebate API

Updated on 2017-10-31T19:54:00+00:00, by wordpress.