Jump to

• Request
• Response

Get Tip Name List

get

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

Retrieve a sorted list of tip names for a particular customer. Sort order is the customer's expected energy savings for each tip, from highest to lowest savings.

Request

Path Parameters

• id(required): integer
  The unique identifier of the customer.
• utilityCode(required): string
  A 3- or 4-character representation of the client code, in all uppercase characters. Valid example "UTIL".

Query Parameters

• channel: string
  Channel to retrieve tips (VOICE, WEB).
• limit: string
  If limit not specified then all tips are retrieved
• locale: string
  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

• application/json

200 Response

Successful operation

Body ()

Root Schema : TipNamesListResponse

Type: object

Response contains an array of tip names.

Show Source

• response: array response
  An array of tip names.

{
    "type":"object",
    "description":"Response contains an array of tip names.",
    "properties":{
        "response":{
            "type":"array",
            "description":"An array of tip names.",
            "items":{
                "$ref":"#/definitions/StringList"
            }
        }
    },
    "example":{
        "response":[
            "tip001_buy_energy_star",
            "tip011_recycle_second_refrigerator",
            "tip059_use_power_strips",
            "tip069_install_efficient_showerheads",
            "tip070_reduce_water_heater_temperature",
            "tip047_use_efficient_lighting",
            "tip071_turn_off_water_heater_when_away",
            "tip060_unplug_devices",
            "tip018_improve_window_shading",
            "tip010_hang_dry_laundry",
            "tip015_maintain_ac",
            "tip001_buy_energy_star"
        ]
    }
}

Example:

{
    "response":[
        "tip001_buy_energy_star",
        "tip011_recycle_second_refrigerator",
        "tip059_use_power_strips",
        "tip069_install_efficient_showerheads",
        "tip070_reduce_water_heater_temperature",
        "tip047_use_efficient_lighting",
        "tip071_turn_off_water_heater_when_away",
        "tip060_unplug_devices",
        "tip018_improve_window_shading",
        "tip010_hang_dry_laundry",
        "tip015_maintain_ac",
        "tip001_buy_energy_star"
    ]
}

Nested Schema : response

Type: array

An array of tip names.

Show Source

• Array of: array StringList
  Tip name

{
    "type":"array",
    "description":"An array of tip names.",
    "items":{
        "$ref":"#/definitions/StringList"
    }
}

Nested Schema : StringList

Type: array

Tip name

Show Source

• Array of: string

{
    "description":"Tip name",
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid request

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

401 Response

Authorization failure

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

404 Response

Customer not found or no tips found for the specified locale

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

500 Response

Internal error

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• details: string
  Details about the error.
• errorMessage: string
  Short failure explanation.
• httpStatus: integer
  Minimum Value: 100

  Maximum Value: 600

  The HTTP status code for the error.
• serviceErrorCode: string
  An error code for the error.

{
    "type":"object",
    "properties":{
        "httpStatus":{
            "description":"The HTTP status code for the error.",
            "type":"integer",
            "minimum":100,
            "maximum":600
        },
        "serviceErrorCode":{
            "description":"An error code for the error.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Short failure explanation.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error.",
            "type":"string"
        }
    },
    "additionalProperties":false
}

Back to Top