{ "opencollection": "1.0.0", "info": { "name": "CDR Energy API", "version": "1.36.0" }, "items": [ { "info": { "name": "Energy Plans", "type": "folder" }, "items": [ { "info": { "name": "Get Generic Plans", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/plans", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "Used to filter results on the _type_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`." }, { "name": "fuelType", "value": "", "type": "query", "description": "Used to filter results on the _fuelType_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`." }, { "name": "effective", "value": "", "type": "query", "description": "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. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`." }, { "name": "updated-since", "value": "", "type": "query", "description": "Only include plans that have been updated after the specified date and time. If absent defaults to include all plans." }, { "name": "brand", "value": "", "type": "query", "description": "Used to filter results on the _brand_ field. If absent defaults to include all plans." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain a list of energy plans that are currently offered to the market.\n\nNote that the results returned by this endpoint are expected to be ordered in descending order according to _lastUpdated_." }, { "info": { "name": "Get Generic Plan Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/plans/:planId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" } ], "params": [ { "name": "planId", "value": "", "type": "path", "description": "ID of the specific plan requested." } ] }, "docs": "Obtain detailed information on a single energy plan offered openly to the market.\n\nOther Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html), [v2](includes/obsolete/get-generic-plan-detail-v2.html)." } ] }, { "info": { "name": "Electricity Service Points", "type": "folder" }, "items": [ { "info": { "name": "Get Service Points", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain a list of service points owned by the customer that has authorised the current session.\n\nOther Versions: [v1](includes/obsolete/get-service-points-v1.html)." }, { "info": { "name": "Get Service Point Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/:servicePointId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "servicePointId", "value": "", "type": "path", "description": "The _servicePointId_ to obtain data for. _servicePointId_ values are returned by service point list endpoints. Note that it is not a _nationalMeteringId_." } ] }, "docs": "Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session.\n\nOther Versions: [v1](includes/obsolete/get-service-point-detail-v1.html)." } ] }, { "info": { "name": "Electricity Usage", "type": "folder" }, "items": [ { "info": { "name": "Get Usage For Service Point", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/:servicePointId/usage", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "servicePointId", "value": "", "type": "path", "description": "The _servicePointId_ to obtain data for. _servicePointId_ values are returned by service point list endpoints. Note that it is not a _nationalMeteringId_." }, { "name": "oldest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or after this date. If absent defaults to _newest-date_ minus 24 months. Format is aligned to DateString common type." }, { "name": "newest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type." }, { "name": "interval-reads", "value": "", "type": "query", "description": "Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to `NONE`." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain a list of electricity usage data from a particular service point." }, { "info": { "name": "Get Bulk Usage", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/usage", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "interval-reads", "value": "", "type": "query", "description": "Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to `NONE`." }, { "name": "oldest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or after this date. If absent defaults to _newest-date_ minus 24 months. Format is aligned to DateString common type." }, { "name": "newest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain usage data for all service points associated with the customer." }, { "info": { "name": "Get Usage For Specific Service Points", "type": "http" }, "http": { "method": "POST", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/usage", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "oldest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or after this date. If absent defaults to _newest-date_ minus 24 months. Format is aligned to DateString common type." }, { "name": "newest-date", "value": "", "type": "query", "description": "Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type." }, { "name": "interval-reads", "value": "", "type": "query", "description": "Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to `NONE`." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain the electricity usage data for a specific set of service points." } ] }, { "info": { "name": "Distributed Energy Resources", "type": "folder" }, "items": [ { "info": { "name": "Get DER For Service Point", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/:servicePointId/der", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "servicePointId", "value": "", "type": "path", "description": "The _servicePointId_ to obtain data for. _servicePointId_ values are returned by service point list endpoints. Note that it is not a _nationalMeteringId_." } ] }, "docs": "Obtain a list of DER data from a particular service point." }, { "info": { "name": "Get Bulk DER", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/der", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain DER data for all service points associated with the customer." }, { "info": { "name": "Get DER For Specific Service Points", "type": "http" }, "http": { "method": "POST", "url": "https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints/der", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Obtain DER data for a specific set of service points." } ] }, { "info": { "name": "Energy Accounts", "type": "folder" }, "items": [ { "info": { "name": "Get Energy Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain the list of energy accounts available under the authorised consent.\n\nOther Versions: [v1](includes/obsolete/get-energy-accounts-v1.html)." }, { "info": { "name": "Get Energy Account Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts/:accountId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain detailed information for a specific energy account.\n\nOther Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html), [v2](includes/obsolete/get-energy-account-detail-v2.html), [v3](includes/obsolete/get-energy-account-detail-v3.html)." }, { "info": { "name": "Get Agreed Payment Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts/:accountId/payment-schedule", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain the agreed payment schedule and details, if any, for a specific energy account.\n\nSome general notes about this endpoint:\n\n