{"info":{"_postman_id":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","name":"Intermittent Generation Availability Prod","description":"

API status

\n

Draft for review. AEMO releases new versions as the design is updated and feedback received.

\n

About Intermittent Generation APIs

\n

Australian Wind Energy Forecasting System (AWEFS) and the Australian Solar Energy Forecasting System (ASEFS) were established in response to the growth in intermittent generation and the increasing impact this growth has on the forecasting process.

\n\n

AEMO uses AWEFS and ASEFS to produce unconstrained intermittent\ngeneration forecasts for all semi-scheduled and significant non-scheduled wind\nand solar generating units in the NEM.

\n\n

The Intermittent Generation Availability APIs allow authorised participants to submit plant availability data to AEMO which is used to generate the forecasts for the pre-dispatch, short-term and medium-term timeframes. These forecasts are then used in the pre-dispatch, PD/STPASA and MTPASA processes.

\n

Prerequisites

\n

Before you use the Intermittent Generation APIs you must:

\n
    \n
  1. Have a Participant ID with an effective date of registration. If your company is a Registered Participant, it is set up during the registration process.
    2. \n
  2. Have a user ID and password with access rights provided by your company's participant administrator. For details, see user rights access below.
    3. \n
  3. Have an API gateway and a TLS certificate.
    4. \n
  4. Know your Dispatchable Unit Identifier (DUID).
    5. \n
  5. 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.
    6. \n
\n\n

Related rules and procedures

\n

Participants are required to submit plant availability information to AEMO as per NER clause 3.7B (b). The Intermittent Generation Availability APIs facilitate participants to submit this information to AEMO.

\n\n

User rights access

\n\n
\n

API account passwords expire every 90 days.

\n
\n

Participant administrators provide access to the Intermittent Generation API using the following URM entity:

\n\n\n\n

Steps to set up URM rights

\n

The steps to set up URM rights for API access are:

\n\n

For help with user rights access, see Guide to User Rights Management.

\n\n
    \n
  1. \n  If required, the Participant Administrator (PA) creates a new Participant User in MSATS.
    2. \n
  2. The PA assigns the URM entity to the Participant User.
    3. \n
\n

Compression

\n

You can submit your API compressed or uncompressed. Compression protocols are gzip or deflate.

\n\n

Throttling

\n

To control traffic, AEMO implements Throttling on API Endpoint requests. If Participant ID requests exceed the Throttling limit a HTTP 429 response returns.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n

Endpoint

\n 		\n

Limits

\n
\n

PdStPasaAvailability

\n 		\n

1 request per second per participantId.

\n

The participantId is identified from the X-initiatingParticipantID request header parameter. Participants systems must manage this Throttling limit because if you submit multiple JSON requests for the same participantId at the same time, AEMO may reject some.

\n
\n

MtPasaAvailability

\n 		\n

MtPasaAvailability

\n

1 request per second per participantId

\n
\n\n

Response codes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n

Code

\n 		\n

Description

\n 		\n

Scenario

\n
\n

200

\n 		\n

Submission successful

\n 		\n

The payload is validated and saved in the AEMO's systems.

\n
\n

400

\n 		\n

Bad request

\n 		\n

The submitted payload cannot be passed successfully.

\n
\n

401

\n 		\n

Unauthorized

\n 		\n

The authorization credentials, username or password are entered incorrectly or invalid.\n

\n

403

\n 		\n

Resource is missing from URL or incorrect URL\n

\n

Insufficient privileges\n

\n

404

\n 		\n

Resources for the endpoint URI not found

\n 		\n

The URI details are incorrect. For help, see Bidding Service Open API specification > Paths

\n
\n

405

\n 		\n

Method not allowed

\n 		\n

The request method is invalid, e.g. GET instead of POST.

\n
\n

422

\n 		\n

Method is not correct

\n 		\n

Business validation failure

\n
\n

429

\n 		\n

Too many requests

\n 		\n

Possible reasons:

\n
    \n
  • The requests exceed the throttling limit of 1 request per second. Wait and retry the submission.
    • \n
  • A primary key violation due to a backend process error where the request slips through the throttling validation and triggers a primary key violation. Wait and retry the submission.
    • \n
\n
\n

500

\n 		\n

Unforeseen error, such as; Certificate/key do not match or incorrect or e-Hub/API/downstream service is not available or Malformed payload.

\n 		\n

Possible reasons:

\n
    \n
  • \n

    The Certificate or key do not match.

    \n
    • \n
  • \n

    The AEMO Gateway is unavailable. Wait and retry the submission.

    \n
    • \n
\n
\n

502

\n 		\n

Bad gateway

\n 		\n

The AEMO Gateway is unavailable. Wait and retry the submission.

\n
\n

503

\n 		\n

Service temporarily unavailable

\n 		\n

Service unavailable

\n
\n\n

Glossary

\n

For help with terms see:

\n
  • National Electricity Rules Glossary
    • \n
  • Industry Terminology
    • ","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API status","slug":"api-status"},{"content":"About Intermittent Generation APIs ","slug":"about-intermittent-generation-apis"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"Related rules and procedures","slug":"related-rules-and-procedures"},{"content":"User rights access","slug":"user-rights-access"},{"content":"Compression","slug":"compression"},{"content":"Throttling","slug":"throttling"},{"content":"Response codes","slug":"response-codes"},{"content":"Glossary","slug":"glossary"}],"owner":"10032049","collectionId":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","publishedId":"2s93CNMt6L","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-02-24T00:46:40.000Z"},"item":[{"name":"PdStPasaAvailability","id":"e657a822-20ee-409d-9ad4-5f6f295a06ff","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"X-initiatingParticipantID","value":"TEST","description":"

    Required Participant ID, type: string

    \n","type":"text"},{"key":"X-market","value":"NEM","description":"

    Required Market, type: string

    \n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n\"MwLimits\": [{\r\n\"duid\": \"TEST\",\r\n\"mwLimit\": 17,\r\n\"intervalDateTime\": \"2021-11-12T12:30:00+10:00\"\r\n}],\r\n\"clusterElements\": [{\r\n\"duid\": \"TEST\",\r\n\"clusterId\": \"TEST_C1\",\r\n\"intervalDateTime\": \"2021-11-12T01:00:00+10:00\",\r\n\"elementsAvailable\": 1\r\n}]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://apis.prod.aemo.com.au:9319/v1/IntermittentGen/PdStPasaAvailability","description":"

    PdStPasaAvailability

    \n

    The PdStPasaAvailability endpoint allows participants to submit plant availability information for 30-minute intervals, which will be used to produce the pre-dispatch and PD/STPASA forecasts.

    \n\n

    This endpoint has payload parameters only (no query parameters). The json request payload must contain at east one of the two json tags mwLimits or clusterElements.

    \n\n

    Every submission must supply all the submission level information. Otherwise, AEMO rejects the submission.

    \n\n

    GATEWAY ADDRESSES

    \n

    MARKETNET

    \n

    \n https://apis.prod.marketnet.net.au:9319/api/v1/IntermittentGen/PdStPasaAvailability\n

    \n\n

    \n https://partner.api.preprod.aemo.com.au/api/v1/IntermittentGen/PdStPasaAvailability\n

    \n\n

    INTERNET DIRECT

    \n

    \n https://apis.prod.aemo.com.au:9319/api/v1/IntermittentGen/PdStPasaAvailability\n

    ","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","id":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","name":"Intermittent Generation Availability Prod","type":"collection"}},"urlObject":{"protocol":"https","port":"9319","path":["v1","IntermittentGen","PdStPasaAvailability"],"host":["apis","prod","aemo","com","au"],"query":[],"variable":[]}},"response":[{"id":"109df4c2-138f-46ac-9109-8c07706776fb","name":"PdStPasaAvailability 200","originalRequest":{"method":"POST","header":[{"key":"X-initiatingParticipantID","value":"ARARATWF","description":"Required Participant ID, type: string","type":"text"},{"key":"X-market","value":"NEM","description":"Required Market, type: string","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\r\n\"MwLimits\": [{\r\n\"duid\": \"ARWF1\",\r\n\"mwLimit\": 17,\r\n\"intervalDateTime\": \"2021-11-12T12:30:00+10:00\"\r\n}],\r\n\"clusterElements\": [{\r\n\"duid\": \"ARWF1\",\r\n\"clusterId\": \"ARWF1_C1\",\r\n\"intervalDateTime\": \"2021-11-12T01:00:00+10:00\",\r\n\"elementsAvailable\": 1\r\n}]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://apis.prod.aemo.com.au:9319/v1/IntermittentGen/PdStPasaAvailability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Nov 2021 23:23:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"deflate"},{"key":"Vary","value":"Accept"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Set-Cookie","value":"TS01e740ef=017e70caad32aaa4ef495b19746ec255cf9252eaa3bc6a97ea7560bee922476fc06193a05783551fff703a472d46d9ff5571bc2c18; Path=/"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"7738486476409-b-gsy1-6197-15394396-1\",\n \"data\": {\n \"responseTimeStamp\": \"2021-11-08T09:23:51\",\n \"responseText\": \"Request has been successfully processed\"\n },\n \"errors\": [],\n \"warnings\": []\n}"}],"_postman_id":"e657a822-20ee-409d-9ad4-5f6f295a06ff"},{"name":"MtPasaAvailability","id":"fb6cc9e4-1f2b-4284-9226-c11540cc678c","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"X-initiatingParticipantID","value":"TEST","description":"

    Required Participant ID, type: string

    \n","type":"text"},{"key":"X-market","value":"NEM","description":"

    Required Market, type: string

    \n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"mwLimits\": [{\r\n\"duid\": \"TEST\",\r\n\"mwLimit\": 22,\r\n\"date\": \"2021-11-20\"\r\n}],\r\n\"clusterElements\": [{\r\n\"duid\": \"TEST\",\r\n\"clusterId\": \"TEST_C1\",\r\n\"date\": \"2021-11-19\",\r\n\"elementsAvailable\":1\r\n}]\r\n}"},"url":"https://apis.prod.aemo.com.au:9319/v1/IntermittentGen/MtPasaAvailability","description":"

    MtPasaAvailability - payload parameters (not query parameters)

    \n

    The MtPasaAvailability endpoint allows participants to submit daily plant availability information, which will be used to produce the MTPASA forecasts.\n

    This endpoint has query parameters only (no payload parameters). \n

    The json request payload must contain at east one of the two json tags mwLimits or cluterElements.

    \n\n

    GATEWAY ADDRESSES

    \n

    MARKETNET

    \n

    \n https://apis.prod.marketnet.net.au:9319/api/v1/IntermittentGen/MtPasaAvailability\n

    \n\n

    \n https://partner.api.preprod.aemo.com.au/api/v1/IntermittentGen/MtPasaAvailability\n

    \n\n

    INTERNET DIRECT

    \n

    \n https://apis.prod.aemo.com.au:9319/api/v1/IntermittentGen/MtPasaAvailability\n

    ","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","id":"8123d3b0-75d8-47f1-a17e-b4ab85d249ee","name":"Intermittent Generation Availability Prod","type":"collection"}},"urlObject":{"protocol":"https","port":"9319","path":["v1","IntermittentGen","MtPasaAvailability"],"host":["apis","prod","aemo","com","au"],"query":[],"variable":[]}},"response":[{"id":"48f95f59-474f-4723-bc33-87a9ba95301a","name":"MtPasaAvailability 200","originalRequest":{"method":"POST","header":[{"key":"X-initiatingParticipantID","value":"ARARATWF","description":"Required Participant ID, type: string","type":"text"},{"key":"X-market","value":"NEM","description":"Required Market, type: string","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"mwLimits\": [{\r\n\"duid\": \"ARWF1\",\r\n\"mwLimit\": 22,\r\n\"date\": \"2021-11-20\"\r\n}],\r\n\"clusterElements\": [{\r\n\"duid\": \"ARWF1\",\r\n\"clusterId\": \"ARWF1_C1\",\r\n\"date\": \"2021-11-19\",\r\n\"elementsAvailable\":1\r\n}]\r\n}"},"url":"https://apis.prod.aemo.com.au:9319/v1/IntermittentGen/MtPasaAvailability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Nov 2021 01:24:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"deflate"},{"key":"Vary","value":"Accept"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Set-Cookie","value":"TS01e740ef=017e70caad82e59090d0bab9ab718c859bfcf4d61811ffa8b16247ed208e0bc4a98acc2a876b2cd72c3a061cff33a6efe029772a99; Path=/"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionId\": \"8871918045895-b-gsy1-1371-16028012-1\",\n \"data\": {\n \"responseTimeStamp\": \"2021-11-08T11:24:13\",\n \"responseText\": \"Request has been successfully processed\"\n },\n \"errors\": [],\n \"warnings\": []\n}"}],"_postman_id":"fb6cc9e4-1f2b-4284-9226-c11540cc678c"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"d0c9713d-275f-489b-b9a2-d597e841d6fc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"251620fe-1241-45a4-80cd-d39270fe8582","type":"text/javascript","exec":[""]}}]}