Jump to

• Request
• Response

Get Home Profile

get

/apis/customer-data-v2/{utilityCode}/customers/{id}/home_profile

Returns the home profile for a customer, including demographics and information about the home.

Request

Path Parameters

• id(required): integer
  Customer id to list utility accounts for.
• utilityCode(required): string
  A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util"

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Home Profile for this customer returned.

Body ()

Root Schema : HomeProfileResponse

Type: object

Show Source

• response: array response

{
    "type":"object",
    "properties":{
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HomeProfile"
            }
        }
    },
    "example":{
        "response":{
            "customerId":31,
            "dwellingType":"SINGLE_FAMILY",
            "squareFeet":2100,
            "heatType":"ELEC",
            "numberOfAdults":2,
            "numberOfChildren":1
        }
    }
}

Example:

{
    "response":{
        "customerId":31,
        "dwellingType":"SINGLE_FAMILY",
        "squareFeet":2100,
        "heatType":"ELEC",
        "numberOfAdults":2,
        "numberOfChildren":1
    }
}

Nested Schema : response

Type: array

Show Source

• Array of: object HomeProfile

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/HomeProfile"
    }
}

Nested Schema : HomeProfile

Type: object

Show Source

• customerId: integer
  The internal customer id

  Example: 31
• dwellingType: string
  Allowed Values: [ "MULTI_FAMILY", "NON_RESIDENTIAL", "SINGLE_FAMILY" ]

  The type of dwelling. Optional.

  Example: SINGLE_FAMILY
• heatType: string
  Allowed Values: [ "ELEC", "GAS", "NONE", "OTHER", "LPG", "OIL", "WOOD", "DISTRICT_HEATING", "GEOTHERMAL" ]

  The type of heating that a dwelling uses

  Example: ELEC
• numberOfAdults: integer
  The number of adults in this dwelling

  Example: 2
• numberOfChildren: integer
  The number of children in this dwelling

  Example: 1
• squareFeet: integer
  The square footage of this dwelling

  Example: 2100

{
    "type":"object",
    "properties":{
        "customerId":{
            "type":"integer",
            "description":"The internal customer id",
            "example":31
        },
        "dwellingType":{
            "$ref":"#/definitions/DwellingType"
        },
        "squareFeet":{
            "type":"integer",
            "description":"The square footage of this dwelling",
            "example":2100
        },
        "heatType":{
            "$ref":"#/definitions/HeatType"
        },
        "numberOfAdults":{
            "type":"integer",
            "description":"The number of adults in this dwelling",
            "example":2
        },
        "numberOfChildren":{
            "type":"integer",
            "description":"The number of children in this dwelling",
            "example":1
        }
    }
}

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 or site not found

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