1. Oracle Utilities REST API for Digital Self Service Energy Management
  2. Tasks
  3. Tips

Get Tip List

get

/apis/tips-v1/{utilityCode}/energy_guide/customers/{id}/tips/list

Retrieves a list of relevant tips. Sort order is the customer's expected energy savings for each tip, from highest to lowest savings.

Request

Path Parameters
Query Parameters
  • Channel to retrieve tips (VOICE, WEB).
  • If limit not specified then all tips are retrieved
  • The locale to retrieve tips in language_territory format which uses two letters for language and territory. For example en_US or fr_FR. The customer locale is used as the default. Only locales supported by the utility are allowed.
Back to Top

Response

Supported Media Types

200 Response

Successful response
Body ()
Root Schema : TipListResponse
Type: object
Response contains a list of prioritized tips.
Show Source
Example:
{
    "response":[
        {
            "tipName":"tip018_improve_window_shading",
            "title":"Improve shading for windows",
            "score":215.68625,
            "group":"COOLING",
            "fuelType":[
                "ELEC"
            ],
            "costCategory":"SMART_PURCHASE",
            "image":"tip018_improve_window_shading.jpg",
            "status":"WILL_DO",
            "numParticipating":4984,
            "season":[
                "SUMMER",
                "SPRING"
            ],
            "why":"If the sun creates overwhelming heat in your home during the warmer months, you may wish to make targeted investments to improve the way you shade your windows.",
            "shortBody":"<p>Window shades can help you stay cooler in the summer and warmer in the winter.</p>\n<p>Shading the outside of your windows with awnings, shutters, solar blinds, or solar screening will most effectively block summer heat, while indoor window treatments insulate well in the winter.</p>\n<p>Use what's right for each window. Pay special attention to windows that face south, east, and west and receive the most sunlight.</p>",
            "longBody":"<strong>Things to think about:</strong>\n<ul>\n<li>Provide adequate shade ??? especially to windows that face south, west, or east, since they let in the most heat in summer months.</li>\n<li>Shading the outside of your windows is more effective at blocking heat than using indoor shades or drapes. Consider shading the exterior of your home with shutters, awnings, exterior solar blinds or solar screening. Just remember that you'll want any exterior shading to be removable during the winter months, when sunlight can help heat your home's interior.</li>\n<li>Planting deciduous trees ??? trees that usually lose their leaves in the fall ??? nearby is an excellent way to increase shading, because it shades the windows in the summer but allows sun exposure in the winter.</li>\n<li>Light-colored drapes and shades reflect the sun's energy, while darker ones absorb it and release heat.</li>\n<li>Remote control blinds are available for hard-to-reach windows.</li>\n</ul>",
            "savings":"Save up to $90 per year",
            "cost":"Varies. Solar screens cost an average of $0.05 per square foot. New shades start at about $30.",
            "payback":"Six months to two years.",
            "imagePathsBySize":{
                "40x40":"https://dh9c80tglww64.cloudfront.net/asset_files/528911/tip018_improve_window_shading.jpg",
                "60x60":"https://dh9c80tglww64.cloudfront.net/asset_files/528913/tip018_improve_window_shading.jpg",
                "75x75":"https://dh9c80tglww64.cloudfront.net/asset_files/528916/tip018_improve_window_shading.jpg",
                "80x100":"https://dh9c80tglww64.cloudfront.net/asset_files/528917/tip018_improve_window_shading.jpg",
                "140x140":"https://dh9c80tglww64.cloudfront.net/asset_files/528919/tip018_improve_window_shading.jpg",
                "140x170":"https://dh9c80tglww64.cloudfront.net/asset_files/528921/tip018_improve_window_shading.jpg",
                "190x230":"https://dh9c80tglww64.cloudfront.net/asset_files/528922/tip018_improve_window_shading.jpg",
                "large":"https://dh9c80tglww64.cloudfront.net/asset_files/528924/tip018_improve_window_shading.svg",
                "small":"https://dh9c80tglww64.cloudfront.net/asset_files/528925/tip018_improve_window_shading.svg"
            }
        },
        {
            "tipName":"tip013_save_on_washing_dishes",
            "title":"Be smart about dishwashing",
            "score":"-Infinity",
            "group":"APPLIANCES",
            "fuelType":[
                "ELEC",
                "GAS"
            ],
            "costCategory":"FREE",
            "image":"tip013_save_on_washing_dishes.jpg",
            "status":"DONE",
            "numParticipating":2589,
            "why":"Your dishwasher uses a great deal of energy, especially for heating water. There are several steps you can take starting today ??? with no up-front investment ??? to reduce your bills associated with dishwashing.<br />",
            "shortBody":"<p>Save money when using your dishwasher by following these three steps:</p>\n<ul>\n<li>First, make sure you and other household members only run full loads.</li>\n</ul>\n<ul>\n<li>Next, instead of using the \"heat dry\" function, air-dry your dishes or use a towel.</li>\n</ul>\n<ul>\n<li>Finally, avoid special cycles such as \"rinse-hold\" or \"pre-rinse,\" which increase the amount of energy and hot water the dishwasher uses.</li>\n</ul>",
            "longBody":"<strong>Step by step:</strong> \n<ul>\n<li><strong>Run full loads.</strong></li>\n<li><strong>Air-dry.</strong> Instead of using the \"heat dry\" function of your washer, air dry your dishes or towel them off. If your washer does not have a special setting to turn off the \"heat dry\" function, simply open the dishwasher and/or press cancel when it reaches this stage. Air drying can save 15-50% on energy use.</li>\n<li><strong>Avoid special cycles.</strong> Avoid using rinse-hold and pre-rinse features, which increase the amount of energy and water the dishwasher uses.</li>\n<li><strong>Wipe instead of rinse.</strong> If your dishes have excess food on them, scrape off the debris instead of rinsing it off before putting them in the dishwasher to save on hot water costs. Modern dishwashers are powerful enough to clean your dishes without your having to rinse them in the sink beforehand.</li>\n<li><strong>Save time and energy.</strong> Don't fall into the habit of hand-washing instead of machine washing. <a href=\"http://www.energystar.gov/products/certified-products/detail/dishwashers\">ENERGY STAR<sup>??</sup></a> certified dishwashers use less water than hand washing and can save you hundreds of hours per year.</li>\n</ul>",
            "savings":"Save up to $10 per year",
            "cost":"None",
            "payback":"Immediately",
            "imagePathsBySize":{
                "40x40":"https://dh9c80tglww64.cloudfront.net/asset_files/528288/tip013_save_on_washing_dishes.jpg",
                "60x60":"https://dh9c80tglww64.cloudfront.net/asset_files/528289/tip013_save_on_washing_dishes.jpg",
                "75x75":"https://dh9c80tglww64.cloudfront.net/asset_files/528290/tip013_save_on_washing_dishes.jpg",
                "80x100":"https://dh9c80tglww64.cloudfront.net/asset_files/528292/tip013_save_on_washing_dishes.jpg",
                "140x140":"https://dh9c80tglww64.cloudfront.net/asset_files/528295/tip013_save_on_washing_dishes.jpg",
                "140x170":"https://dh9c80tglww64.cloudfront.net/asset_files/528296/tip013_save_on_washing_dishes.jpg",
                "190x230":"https://dh9c80tglww64.cloudfront.net/asset_files/528298/tip013_save_on_washing_dishes.jpg",
                "large":"https://dh9c80tglww64.cloudfront.net/asset_files/528302/tip013_save_on_washing_dishes.svg",
                "small":"https://dh9c80tglww64.cloudfront.net/asset_files/528303/tip013_save_on_washing_dishes.svg"
            }
        },
        {
            "tipName":"tip004_choose_efficient_clothes_washer",
            "title":"Replace your old clothes washer",
            "score":476.4362,
            "group":"APPLIANCES",
            "fuelType":[
                "ELEC",
                "GAS"
            ],
            "costCategory":"GREAT_INVESTMENT",
            "image":"tip004_choose_efficient_clothes_washer.jpg",
            "status":"WILL_DO",
            "numParticipating":1692,
            "why":"Washing your clothes uses a significant amount of energy, especially if you use warm or hot water. New, efficient clothes washers use less water and energy than old and conventional washers, resulting in energy savings.<br />",
            "shortBody":"<p>ENERGY STAR<sup>?? </sup> certified clothes washers use about 25% less energy and 40% less water than non-certified models.</p> <p>New, efficient washers spin more water out of clothes, so your dryer won't have to work as hard. They can handle larger loads and are gentler on your clothes, too.</p> <p>Conventional washers manufactured before 2003 are especially inefficient. If you have one, consider an upgrade soon.</p>",
            "longBody":"<strong>What to look for:</strong> <ul> <li><strong><a href=\"http://www.energystar.gov/products/certified-products/detail/clothes-washers\">ENERGY STAR<sup>??</sup></a> certified clothes washers.</strong> They use nearly 25% less energy and 40% less water compared to non-certified washers. Look up efficient models <a title=\"ENERGY STAR Qualified Clothes Washers\" href=\"https://data.energystar.gov/products/find-a-product/certified-clothes-washers\">here.</a></li> <li><strong>A Modified Energy Factor (MEF) of 2.0 or higher.</strong> The MEF considers the energy used by the washer, the energy to heat the water, and the energy used by the dryer. The higher the MEF, the more energy efficient the clothes washer.</li> <li><strong>A low Water Factor (WF).</strong> WF measures the amount of water the washer uses. The lower the WF, the more water efficient the clothes washer.</li> <li><strong>The right size.</strong> Choose a washer that's sized appropriately for your household.</li> </ul> <p><br /> <strong>Added benefits:</strong></p> <ul> <li><strong>Wash more clothes.</strong> Some front-loading models without an agitator and some advanced top loaders can handle more clothes per load, which means fewer loads are needed to finish the laundry.</li> <li><strong>Gentler on clothes.</strong> Front-loading clothes washers are also easier on your clothes, helping them last longer. Advanced top-loaders are also gentler.</li> <li><strong>Dry less.</strong> Efficient washers extract more water from clothes, so they dry faster.</li> </ul> <p><br /> <strong>Good to know:</strong> An ENERGY STAR certified clothes washer will save you the most energy if your current clothes washer was manufactured before the year 2003.</p>",
            "savings":"Save up to $25 per year, plus get a UtilityCo rebate"
        }
    ]
}
Nested Schema : TipList
Type: array
Show Source
Nested Schema : TipDTO
Type: object
Show Source
Nested Schema : FuelTypeList
Type: array
The fuel types supported for the tip.
Show Source
Nested Schema : imagePathsBySize
Type: object
Additional Properties Allowed
Show Source
Absolute URIs of the path to the tip image for the applicable image size.
Nested Schema : TipsSeasonList
Type: array
Seasons the tip applies to.
Show Source

400 Response

Invalid request
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

401 Response

Authorization failure
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

404 Response

Customer not found or no tips found for the specified locale
Body ()
Root Schema : ErrorResponse
Type: object
Show Source

500 Response

Internal error
Body ()
Root Schema : ErrorResponse
Type: object
Show Source
Back to Top