Jump to

• Request
• Response

Get Utility Account List

get

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

Returns the list of utility accounts associated to a given customer satisfying the query parameters.

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. Utility accounts for this customer returned.

Body ()

Root Schema : UtilityAccountsResponse

Type: object

Show Source

• response: array response

{
    "type":"object",
    "properties":{
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UtilityAccount"
            }
        }
    },
    "example":{
        "response":{
            "id":1071,
            "utilityAccountId":"1872099045",
            "moveInDate":"2011-10-15",
            "meterType":"ELEC",
            "resolution":"HALF_HOUR"
        }
    }
}

Example:

{
    "response":{
        "id":1071,
        "utilityAccountId":"1872099045",
        "moveInDate":"2011-10-15",
        "meterType":"ELEC",
        "resolution":"HALF_HOUR"
    }
}

Nested Schema : response

Type: array

Show Source

• Array of: object UtilityAccount

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

Nested Schema : UtilityAccount

Type: object

Show Source

• id: integer
  Unique identifier within OPOWER of this utility account; this is how you identify utility accounts in further URIs

  Example: 1071
• meterType: string
  Allowed Values: [ "ELEC", "GAS" ]

  The fuel type of the meter.
• moveInDate: string
  The move in date for this account

  Example: 1999-01-01
• moveOutDate: string
  The optional move out date for this account

  Example: 2010-01-01
• resolution: string
  Allowed Values: [ "MINUTE", "QUARTER_HOUR", "HALF_HOUR", "HOUR", "DAY", "MONTH", "BILLING" ]

  The read resolution of the meter

  Example: HOUR
• utilityAccountId: integer
  A utility-company-provided account id for this account

  Example: ua_1-9999
• utilityAccountId2: integer
  An optional utility-company-provided account id for this account

  Example: ua_2-1212

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Unique identifier within OPOWER of this utility account; this is how you identify utility accounts in further URIs",
            "example":1071
        },
        "utilityAccountId":{
            "type":"integer",
            "description":"A utility-company-provided account id for this account",
            "example":"ua_1-9999"
        },
        "utilityAccountId2":{
            "type":"integer",
            "description":"An optional utility-company-provided account id for this account",
            "example":"ua_2-1212"
        },
        "moveInDate":{
            "type":"string",
            "description":"The move in date for this account",
            "example":"1999-01-01"
        },
        "moveOutDate":{
            "type":"string",
            "description":"The optional move out date for this account",
            "example":"2010-01-01"
        },
        "meterType":{
            "$ref":"#/definitions/FuelType"
        },
        "resolution":{
            "$ref":"#/definitions/ReadResolution"
        }
    }
}

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

Utility Account 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