Retrieve FRMP Details (Energy only)
This is an internal call that is essentially separated into two parts. The first is to retrieve the service points/connections that a retailer was the Financially Responsible Market Participant (FRMP) for. This is then used to perform usage calls to the Secondary Data Holder (i.e., AEMO). Please see the UML diagrams under each of the CDS endpoints for further information about how these calls work.
Data Adapter APIβ
Retrieve FRMP Detailsβ
Loading...
Consumer Data Standards Associationsβ
This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoints.
These calls are pass-through calls to AEMO which rely upon a Retrieve FRMP Details response prior to crafting the downstream request.
Get Service Points for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 Service Points UMLβ

Get Service Point Detail for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 Service Point Detail UMLβ

Get Usage for Service Point for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 Usage for Service Pointβ

Get Bulk Usage for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 Service Point Usage UMLβ

Get Usage for Specific Service Points for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 Usage for Specific Service Points UMLβ

Get DER for Service Point for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 DER for Service Pointβ

Get Bulk DER for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 DER for Energy Accountsβ

Get DER for Specific Service Points for 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 the requested path parameter, i.e. principalId, NMI, or OldestDate 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 |
| 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 DER for Specific Service Points UMLβ

Supplemental Fieldsβ
No supplemental fields are specified.
Endpoint Specific Guidanceβ
Please note that the following applies to Retrieve FRMP calls
- If any of the NMIs in the request payload are invalid or do not exist in the data holder system, the data adapter should respond with a 404 error.
- If a NMI in the request payload is valid and does exist in the data holder system, but there is no FRMP details for the NMI at, or after, the oldest date in the request payload, the data adapter should omit it in the response.
- A NMI can have multiple FRMPs associated with it, but only one of those FRMPs can be active (i.e., a FRMP that has a start-date and no end-date, or has a future end-date). Further, start/end dates for the NMIs can't overlap. Please see the example below for clarification, where:
- if the
oldestDateparameter is2019-01-01, all 3 records should be returned. - if the
oldestDateparameter is2019-08-27, all 3 records should be returned. - if the
oldestDateparameter is2020-05-27, only FRMP-002 and FRMP-003 should be returned. - if the
oldestDateparameter is today2023-11-13, only FRMP-003 should be returned, because FRMP-003 does not have endDate, meaning it is still active today.
- if the
{
"nmi1": [
{
"frmpId": "FRMP-001",
"startDate": "2019-03-01",
"endDate": "2019-08-31"
},
{
"frmpId": "FRMP-002",
"startDate": "2019-09-01",
"endDate": "2020-05-31"
},
"frmpId": "FRMP-003",
"startDate": "2020-06-01"
}
]
}
For information on how HaaS measures the Secondary Primary and Large Secondary Primary metrics, please see here