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

Get Tip

get

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

Retrieve a single tip with associated metadata for a customer.

Request

Path Parameters
Query Parameters
  • 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 operation
Body ()
Root Schema : SingleTipResponse
Type: object
Response contains a single tip.
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"
        }
    }
}
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