V1.18.0 Release Notes
Release notes for version v1.18.0 of the CDR Standards.
Changes Made
Change Requests
This release addresses the following minor defects raised on Standards Staging:
- Standards Staging Issue 192: Incorrect property name in EnergyServicePointListResponse definition
- Standards Staging Issue 200: Update documentation clarifying sort date for energy invoices
This release addresses the following change requests raised on Standards Maintenance:
- Standards Maintenance Issue 461: Documentation Improvement: EnergyPlanContract.variation
- Standards Maintenance Issue 472: Modify Energy Plans structure to allow Time of Use based Controlled Load rates
- Standards Maintenance Issue 481: Provide timeline of when multiple sectors per data holder brand will be supported
- Standards Maintenance Issue 485: Common Data Clusters altered for Energy Data Language
- Standards Maintenance Issue 486: Allow ADRs to specify scopes for a Software Statement Assertion (SSA) to support cross industry software products
- Standards Maintenance Issue 487: DCR APIs non-normative examples would benefit from clarification
- Standards Maintenance Issue 489: v1.15.0 More ambiguity into x-fapi-auth-date not less
- Standards Maintenance Issue 491: ID Token algorithm support requirements are ambiguous
- Standards Maintenance Issue 493: Get Transaction Detail - Client Error documentation
- Standards Maintenance Issue 494: Response payload structure description error
- Standards Maintenance Issue 495: Energy - GetAgreedPaymentSchedule API - manualPayment section should have paymentFrequency instead of billFrequency field
- Standards Maintenance Issue 497: CommonEmailAddress - address format documentation
- Standards Maintenance Issue 499: Unknown field in Energy Secondary Data Holder OpenAPI spec
- Standards Maintenance Issue 502: Review ENUM values for representation of days in Energy Standards
- Standards Maintenance Issue 505: Representation of time within EnergyPlanDetail Schema
- Standards Maintenance Issue 507: FDO for data holders ignoring unsupported authorisation scopes to be set earlier than energy release date
- Standards Maintenance Issue 510: Register API error codes need to be aligned with the CDS standardised error codes
- Standards Maintenance Issue 511: Iteration 11 Holistic Feedback
- Standards Maintenance Issue 512: Distributor needed for EnergyPlan.geography object
- Standards Maintenance Issue 514: Get Usage For ... Shared Responsibility APIs Payload size
- Standards Maintenance Issue 521: Transition of required parameters in the CDR Arrangement JWT
Decision Proposals
This release addresses the following Decision Proposals published on Standards:
Introduction
Change | Description | Link |
---|---|---|
Future Dated Obligations | Standards Maintenance #507: Registration validation future obligation date changed from 15th November 2022 to 31st August 2022 | Future Dated Obligations |
High Level Standards
Change | Description | Link |
---|---|---|
Response Payload Structure | Standards Maintenance #494: Corrected documentation to refer to the API response, not request. | Payload Conventions |
Introduction | Updated the introduction to include correct links to CDR agencies. | Introduction |
Informative References | Updated the informative reference for CDR and added new informative references for Treasury, ACCC and the OAIC. | Introduction |
Array Conventions - Payload Conventions | Fixed the HTML rendering for the Markdown bullet point list in the array conventions | Payload Conventions |
SHOULD/MUST Language | The language for some of the common types (e.g. MaskedPANString) use 'should' inconsistently with RFC2119 as their language predates the use of the RFC. This has been corrected | Common Field Types |
API End Points
Change | Description | Link |
---|---|---|
Banking - Get Transaction Detail API error list | Standards Maintenance Issue 493: Fixed error codes presented in the Responses section to display the HTTP status code for Unavailable Resource and Invalid Resource errors | Get Transaction Detail |
Energy schema | Standards Staging #200: Update the description of EnergyInvoice in EnergyInvoiceListResponse to clarify the sorting is done by issueDate | Energy Schema |
Energy schema | Standards Staging #192 Fixed property value name in EnergyServicePointListResponse from me to meta . |
Energy Schema |
Energy schema | Standards Maintenance #505: Converted timeOfUseRates.timeOfUse.startTime , timeOfUseRates.timeOfUse.endTime ,demandCharges.startTime and demandCharges.endTime to TimeString type |
Energy Schema |
Energy schema | Standards Maintenance #502 Converted EnergyPlanSolarFeedInTariff.timeVaryingTariffs.timeVariations.days and EnergyPlanTariffPeriod.demandCharges.days into ENUM. Updated ENUM values for EnergyPlanTariffPeriod.timeOfUseRates.timeOfUse.days to the same as the other days fields. |
Energy Schema |
Energy schema | Standards Maintenance #495:
|
Energy Schema |
Energy schema | Standards Maintenance #512 Added distributors string array field to EnergyPlan.geography object |
Energy Schema |
(Energy) Fix conditional statement for contract variation | Standards Maintenance Issue #461: Corrected the EnergyPlanContract_variation conditional statement such that the variation is required if the isFixed property is false . |
Get Generic Plan Detail and Get Energy Account Detail |
(Energy) Fix incorrect required reference in relatedParticipants | Standards Maintenance Issue #499: Corrected an issue with the EnergyServicePointDetail_relatedParticipants object that incorrectly referenced the location of a sibling object. This issue occurs in both consumer facing and Energy Secondary DH APIs. |
Get Service Point Detail |
CommonEmailAddress | Standards Maintenance #497: Fixed external reference for email format to be "addr-spec". | Common APIs |
x-fapi-auth-date references in resource APIs |
Standards Maintenance #489: Corrected the documentation for x-fapi-auth-date references. |
Banking APIs and Energy APIs |
DCR Non Normative Examples | Standards Maintenance #487: Fixed the URL for DCR examples to remove an extraneous /register/ path component | DCR APIs |
Energy schema | Standards Maintenance #514 Made changes to EnergyUsageRead structure of both primary and secondary data holder to optimise sharing of large volume of interval read data. The change also includes adding a new interval-reads query parameter to usage APIs. |
Energy Schema |
Energy schema | Standards Maintenance #472 Made EnergyPlanControlledLoad into an array and updated structure to allow representation of time of use based rates. | Energy Schema |
Get Software Statement Assertion (SSA) | Standards Maintenance #486: Added reference to obsolete v1 of the GetSSA API | Get Software Statement Assertion (SSA) |
CDR Register APIs Endpoint Version Schedule | Standards Maintenance #486: Added version schedule for obsolete v1 of the GetSSA API | Endpoint Version Schedule |
Register APIs | Standards Maintenance #481: Removed constraint that data holder brands only map to a single industry | Register APIs |
Get Metric Applicability | Standards Maintenance #515: Clarified that AEMO, AER and DELWP do not need to implement Get Metrics | Admin APIs |
Information Security Profile
Change | Description | Link |
---|---|---|
Profile scope data language link | Standards Maintenance #511: Fixed the link in the "OpenID Connect End-User Data" section linking to the CX Data Language: Profile Scope section. Addresses Issue 511 comment. | Authorisation Scopes |
Formatting for Authorisation Code Flow | Standards Maintenance #511: Corrected the formatting of a bullet point list in the Authorisation Code Flow section obligations. Addresses Issue 511 comment. | Authentication Flows |
Formatting for Mandatory Fields | Standards Maintenance #511: Corrected the formatting of a bullet point list in the Array Conventions' Mandatory Fields section. Addresses Issue 511 comment. | Payload Conventions: Array Conventions - Mandatory Fields |
Schema typing for Energy APIs | Standards Maintenance #511: Corrected Updates for the Energy schema types, description and formatting. Addresses Issue 511 comment. | Energy APIs |
Sort order for Energy Usage Reads | Standards Maintenance #511: Updated description of EnergyUsageListResponse in Energy Data Holder and Secondary Data Holders endpoints with sort order. Addresses Issue 511 comment. | Energy APIs |
ADR hosted CDR Arrangement Revocation Endpoint | Standards Maintenance #521: Updates to accomodate JWT transition for lodgement of the CDR Arrangement ID and validation logic for ADRs. | CDR Arrangement Revocation Endpoint |
Client Registration | Standards Maintenance #486: Get Software Statement Assertion API v1 & v2 has the scope claim explicitly defined | Get Software Statement Assertion (SSA) |
ID Token Algorithm Selection Considerations | Standards Maintenance #491: Added clarification on algorithm coverage required for data holders and data recipients | Client Registration |
Consumer Experience
Change | Description | Link |
---|---|---|
Customer Data Language | Standards Maintenance #485: Customer data language standards removed from sector-specific banking and energy sections and added to the common area of the CX standards titled Customer Language: Common. Title for profile scope section amended by adding "Common" to maintain consistency between common areas of the data language standards | Consumer Experience |
Known Issues
Change | Description | Link |
---|---|---|
Future improvements | Standards Maintenance #510: Added future improvement Register API error codes need to be aligned with the CDS standardised error codes | Known Issues |