List Balances
Describes the List Energy Balances call.
Purposeβ
The purpose of this endpoint is to deliver balance information related to a specific Principal (principalId) and a set of Account(s) (accountIds).
This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoint:
- Get Balance for Energy Account
- Get Bulk Balances for Energy
- Get Balances for Specific Energy Accounts
Data Adapter APIβ
List Energy Account Balancesβ
Loading...
Β
Consumer Data Standards Associationsβ
Get Balance For Energy Accountβ
Loading...
Β
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Field | 400 | urn:au-cds:error:cds-all:Field/Invalid | Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Header | 400 | urn:au-cds:error:cds-all:Header/Invalid | Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Expected Error | 400 | urn:au-cds:error:cds-all:GeneralError/Expected | This status code indicates that the Expected Error has encountered. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Missing Required Field | 400 | urn:au-cds:error:cds-all: Field/Missing | Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Internal Server Error | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected | This status code indicates that the server encountered an internal error or misconfiguration. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
Get Bulk Balances for Energyβ
Loading...
Β
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Field | 400 | urn:au-cds:error:cds-all:Field/Invalid | Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Header | 400 | urn:au-cds:error:cds-all:Header/Invalid | Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Expected Error | 400 | urn:au-cds:error:cds-all:GeneralError/Expected | This status code indicates that the Expected Error has encountered. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Missing Required Field | 400 | urn:au-cds:error:cds-all: Field/Missing | Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Internal Server Error | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected | This status code indicates that the server encountered an internal error or misconfiguration. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
Get Balances For Specific Energy Accountsβ
Loading...
Β
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Field | 400 | urn:au-cds:error:cds-all:Field/Invalid | Applies when the value of required path parameter, i.e. principalId is an invalid type or the value violates the field's constraints. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Header | 400 | urn:au-cds:error:cds-all:Header/Invalid | Applies when a HTTP Header is provided but the value provided is an invalid type or violates the field type constraints as defined in the Consumer Data Standards. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Expected Error | 400 | urn:au-cds:error:cds-all:GeneralError/Expected | This status code indicates that the Expected Error has encountered. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Missing Required Field | 400 | urn:au-cds:error:cds-all: Field/Missing | Applies when the required query parameter is not supplied in the request. The request is missing a mandatory field required for the API. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Internal Server Error | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected | This status code indicates that the server encountered an internal error or misconfiguration. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
Β
Supplemental Fieldsβ
No supplemental fields are specified.
Endpoint Specific Guidanceβ
- The Data Adapter call is made with an
accountIdsfilter at all times as this endpoint is not used prior to an arrangement being established