ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Energy API Get Generic Plans 'effective=CURRENT' returns expired plans #570

Open garychapman opened 1 year ago

garychapman commented 1 year ago

Description

When invoking the Get Generic Plans endpoint with effective=CURRENT, the results set includes plans with an effectiveTo date that is in the past.

e.g. issuing the following cURL command returns plans whose effectiveTo date is 2022-10-23, when they should be excluded from an effective=CURRENT search:

curl --request GET "https://cdr.energymadeeasy.gov.au/electricity-in-a-box/cds-au/v1/energy/plans?effective=CURRENT&page-size=1000" --header "x-v: 1"

Area Affected

The Get Generic Plans endpoint.

Change Proposed

The endoint should behave in accordance with the documentation, which states:

Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields.