Explains the standards, rules, context, conventions, parameters, and methods for the Consumer Data Right (CDR) Status and Outage APIs.
\nThis public API is used to monitor the health status and scheduled outages for CDR.
\nConsumer Data Right for Energy Participants which includes Retailers and Accredited Data Recipients.
\nThis documentation presents the API evolving design. It is updated as the technical requirements are streamlined.
\nThe design is not ready for participants’ builds.
\nThe Consumer Data Standards are developed, maintained, and owned by the Data Standards Body (DSB). Response payload specifications are included in this guide to provide additional context and commentary to assist with the interpretation and processing of returned data.
\nWhere there are any discrepancies between this guide and the Consumer Data Standards, the Consumer Data Standards take precedence.
\nAn understanding of the following is required:
\nBefore you can use the Consumer Data Right (CDR) Status and Outages API, you should test your submission in the pre-production environment before submitting to production. AEMO encourages participants to use the pre-production environment to test procedures and train staff.
\nCDR Status and Outage APIs are accessible over the internet. For details, see the API Reference.
\nAt the scheduled release time, API details, including Swagger/OAS files are available from AEMO’s API Portal:
\nParticipants can connect to the AEMO API Gateway through the internet.
\nJSON
\nThe CDR Status and Outage APIs follow the naming conventions as defined by the Consumer Data Standards body.
\nAEMO APIs support HTTP protocol compression controlled by the HTTP request header attributes, allowing compression before sending and responding.
\nAEMO implements the following throttling on API calls:· 3600 requests per minute.
\nCode | Description | Scenario |
|---|---|---|
200 | OK | The request is processed The data payload is included |
400 | Missing required header | A required field is missing from the request header. See Header parameters |
400 | Invalid header | An invalid field is provided in the request header. Either an unexpected field is included in the request or the value provided is improperly formed. See Header parameters |
400 | Invalid page size | The page size provided is non-numeric or greater than the maximum allowed page size. See Query parameters |
400 | Invalid version | An invalid version is requested. See Header parameters |
404 | Not found | The requested URL is not a valid API endpoint. See API endpoints and response details |
405 | Method not allowed | Expected a GET method and received a POST method |
406 | Unsupported version | The version requested is not supported. See Header parameters |
422 | Invalid page | No data exists for the requested page. See Query parameters |
429 | Too many requests | The total number of inbound CDR API requests received within a minute have exceeded the Participant ID threshold. Wait 1 minute before resubmitting |
500 | Unexpected error encountered or internal server error | An unforeseen error occurred processing the request |
503 | Service unavailable | Service unavailable |
504 | Gateway Timeout | Request timed out |
The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer.
\n"},{"key":"x-min-v","value":"{{CurrentVersion}}","type":"text","description":"The minimum version the requesting party can accept. Optional.
\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/status","description":"Obtain a health check status for the CDR API.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b706719b-01bf-4bcd-a779-bafe03b5cf45","id":"b706719b-01bf-4bcd-a779-bafe03b5cf45","name":"CDR Status and Outages API Reference","type":"collection"}},"urlObject":{"path":["discovery","status"],"host":["https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1"],"query":[],"variable":[]}},"response":[{"id":"5547da6d-ee33-4190-88cc-f694fb120e1b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text"}],"url":"https://mrkt-cdr-02-tst-fna-aue.azurewebsites.net/cds-au/v1/discovery/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"210"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 18 Sep 2023 06:03:36 GMT"},{"key":"Request-Context","value":"appId=cid-v1:ba1102a1-c753-4ed6-95e0-c46c20777171"},{"key":"x-v","value":"1"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"string\",\n \"explanation\": \"string\",\n \"updateTime\": \"2023-09-18T16:00:06+10:00\"\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"},{"id":"29f036f1-a540-465d-963e-bf45a9016a18","name":"Success - All Up","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://mrkt-cdr-02-tst-fna-aue.azurewebsites.net/cds-au/v1/discovery/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"210"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 18 Sep 2023 06:03:36 GMT"},{"key":"Request-Context","value":"appId=cid-v1:ba1102a1-c753-4ed6-95e0-c46c20777171"},{"key":"x-v","value":"1"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"OK\",\n \"explanation\": \"All CDR APIs available\",\n \"updateTime\": \"2023-09-18T16:00:06+10:00\"\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"},{"id":"a3527ca5-85c0-44a6-8576-e6832e356f09","name":"Success - All Fail","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:e3463960-2e43-4a96-9465-6a739bd561b2"},{"key":"x-v","value":"1"},{"key":"Date","value":"Mon, 18 Sep 2023 04:46:03 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"UNAVAILABLE\",\n \"explanation\": \"All CDR APIs are unavailable\",\n \"detectionTime\": \"2023-09-18T14:45:00+10:00\",\n \"updateTime\": \"2023-09-18T14:45:00+10:00\"\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"},{"id":"467b66f8-c0b1-4649-8a9a-da21f8b0341b","name":"Success - Partial","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:e3463960-2e43-4a96-9465-6a739bd561b2"},{"key":"x-v","value":"1"},{"key":"Date","value":"Mon, 18 Sep 2023 05:08:18 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"PARTIAL_FAILURE\",\n \"explanation\": \"The following APIs are unavailable: getDERforSpecificServicePoints, getDERforServicePoint\",\n \"detectionTime\": \"2023-09-18T15:05:18+10:00\",\n \"updateTime\": \"2023-09-18T15:05:18+10:00\"\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"},{"id":"f1f26892-001b-4405-9996-7ce81ed2790a","name":"Success - Outage","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"{{CurrentVersion}}","type":"text"},{"key":"x-min-v","value":"{{MinVersion}}","type":"text"}],"url":{"raw":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/status?&","host":["https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1"],"path":["discovery","status"],"query":[{"key":"","value":null,"description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":null,"value":null,"description":"The minimum version the requesting party can accept. Optional.","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:e3463960-2e43-4a96-9465-6a739bd561b2"},{"key":"x-v","value":"1"},{"key":"Date","value":"Fri, 15 Sep 2023 06:02:59 GMT"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"SCHEDULED_OUTAGE\",\n \"explanation\": \"A Scheduled Outage is currently active\",\n \"expectedResolutionTime\": \"2023-09-15T16:40:00+10:00\",\n \"updateTime\": \"2023-09-07 01:25:06\"\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"}],"_postman_id":"6f3a5e56-7f04-4fca-bbe7-ebef8f941dcf"},{"name":"getOutages","event":[{"listen":"test","script":{"id":"a429479f-4bff-4944-b2fa-cfa937b97e76","exec":["var res = pm.response.json();\r","//************************** STATUS CODE VARIFICATOIN******************** */\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","//************************** HEADER VERIFICATOIN ******************** */\r","pm.test(\"Content-Type header is application/json\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r"," pm.expect(pm.response.headers.get('Content-Type')).to.contain('application/json');\r","});\r","\r","var version = pm.environment.get('CurrentVersion');\r","pm.test(\"x-v is present\", function () {\r"," pm.response.to.have.header(\"x-v\");\r"," pm.expect(pm.response.headers.get('x-v')).to.eql(version);\r","});\r","\r","//**************************RESPONSE PAYLOAD VERIFICATOIN******************** */\r","\r","pm.test(\"Verify data\", function () {\r"," //mandatory\r"," pm.expect(res.data).to.have.property('status', \"OK\");\r"," pm.expect(res.data).to.have.property('explanation', \"All CDR APIs available\");\r"," pm.expect(res.data).not.to.have.property('detectionTime');\r"," pm.expect(res.data).not.to.have.property('expectedResolutionTime');\r"," pm.expect(res.data).to.have.property('updateTime');\r","});\r","\r","var FinalURL = pm.request.url.toString();\r","pm.test(\"Verify links & meta\", function(){\r"," pm.expect(res.links).to.have.property('self', FinalURL);\r"," pm.expect(res.meta).to.exist;\r"," \r","});\r","\r",""],"type":"text/javascript"}}],"id":"72375d88-a990-4f4d-902c-6c706de136e3","protocolProfileBehavior":{"disabledSystemHeaders":{"accept-encoding":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-v","value":"{{CurrentVersion}}","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer.
\n"},{"key":"x-min-v","value":"{{CurrentVersion}}","type":"text","description":"The minimum version the requesting party can accept. Optional.
\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/outages","description":"Obtain a list of scheduled outages for the CDR API.
\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b706719b-01bf-4bcd-a779-bafe03b5cf45","id":"b706719b-01bf-4bcd-a779-bafe03b5cf45","name":"CDR Status and Outages API Reference","type":"collection"}},"urlObject":{"path":["discovery","outages"],"host":["https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1"],"query":[],"variable":[]}},"response":[{"id":"50919827-b37d-4397-8536-e78335f2b7c9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/outages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"outages\": [\n {\n \"outageTime\": \"string\",\n \"duration\": \"string\",\n \"isPartial\": true,\n \"explanation\": \"string\"\n }\n ]\n },\n \"links\": {\n \"self\": \"string\"\n },\n \"meta\": {}\n}"},{"id":"7616e970-edaf-4486-b548-2bcc94ec4675","name":"Success - Current","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/outages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"outages\": [\n {\n \"explanation\": \"DER\",\n \"isPartial\": true,\n \"outageTime\": \"2023-12-04T10:00:00+10:00\",\n \"duration\": \"P10DT4H\"\n }\n ]\n },\n \"links\": {\n \"self\": \"https://mrkt-cdr-02-tst-fna-aue.azurewebsites.net/cds-au/v1/discovery/outages\"\n },\n \"meta\": {}\n}"},{"id":"d3e24e90-46b6-42c3-9e30-e9958684066d","name":"Success - Current and future","originalRequest":{"method":"GET","header":[{"key":"x-v","value":"1.0","type":"text","description":"The version of the requested API endpoint. The highest available supported version between x-min-v and x-v returns. If neither x-min-v and x-v are acceptable, the HTTP response code 406 Not Acceptable returns. Required, type: positive integer."},{"key":"x-min-v","value":"1.0","type":"text","description":"The minimum version the requesting party can accept. Optional.\n"}],"url":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1/discovery/outages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"outages\": [\n {\n \"explanation\": \"NEM25 Retail R2 SAPS PRODUCTION Retail Project Release\",\n \"isPartial\": false,\n \"outageTime\": \"2023-05-28T10:00:00+10:00\",\n \"duration\": \"P140DT6H\"\n },\n {\n \"explanation\": \"Pre-Prod - Expedited NEM 2025 Retail R2 SAPS Project Release\",\n \"isPartial\": false,\n \"outageTime\": \"2023-10-11T15:00:00+10:00\",\n \"duration\": \"P1DT4H\"\n },\n {\n \"explanation\": \"\",\n \"isPartial\": false,\n \"outageTime\": \"2023-12-04T10:00:00+10:00\",\n \"duration\": \"P10DT4H\"\n }\n ]\n },\n \"links\": {\n \"self\": \"https://mrkt-cdr-02-tst-fna-aue.azurewebsites.net/cds-au/v1/discovery/outages\"\n },\n \"meta\": {}\n}"}],"_postman_id":"72375d88-a990-4f4d-902c-6c706de136e3"}],"auth":{"type":"basic","basic":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"e90eae04-c029-4460-8f75-da618f2defa4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"121edd12-7394-429e-a889-f1ec40a68705","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.preprod.aemo.com.au/NEMRetail/cds-au/v1"}]}