A collection of data that is used for a dispatch interval run type is known as a case file. Apart from all the inputs, this will also refer to other parameterized/real-time data.
\nCase files contain the various inputs used by the Dispatch Engine to determine a solution. Case files contain information such as price quantity pairs, ramp limits, and availability for all facilities.
\nCase files are created and made available prior to 12 noon the business day after the trading day, one for each dispatch or pre-dispatch interval.
\nIn addition to dispatch case files, the WEMDE Dispatch API collection allows MPs direct access to the full range of inputs and dispatch outcomes for each market (Energy and Essential System Services (ESS)) for every market solution. The other Dispatch APIs are described in the following API reference documents:
\nDispatch Solution
\nDispatch Instructions
\nDispatch Summary
\nTrading Day Report
\nDSP Dispatch Instruction
\nNot In Service Capacity
\nReference Trading Price
\nFor support, contact: AEMO Real Time Market Submissions Team
Email: wa.operations@aemo.com.au
Ready. The design is ready for participants to use.
\nAPI and JSON or YAML basics.
\n\nBefore you can use the Dispatch Case API you must:
\nHave a Participant ID and Facility Code. If your company is a Registered Participant, your ID is set up during the registration process.
\nHave a DigiCert TLS certificate.
\nFor more information, see the Reformer page Accessing our test environments.
\nTo be included in the next version.
\nThe following essential/mandatory endpoints will be added to the WEMDE UI swaggers in future releases and will also be documented in this guide:
\nDemand side program data
\nMarket schedule scenarios
\nReference trading price
\nFor all APIs, there is an enforced 10 MB max limit.
\nA single participant is restricted to accessing 50 calls every minute, with a total of 200 calls in five minutes.
\nUse the API Reference icon at the top of the portal page to see the details of the paths, headers, request body and responses for each of the endpoints in the API.
\nThe Dispatch Case API uses the following authentication method:
\n\nThe base URLs used for this API are as follows:
\nMarket trial: https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase
\nPre-prod: https://apis.preprod.aemo.com.au:9319/WEM/v1/dispatchCase
\nProduction: https://apis.prod.aemo.com.au:9319/WEM/v1/dispatchCase
\nSome sample data are available throught the following link:
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API status","slug":"api-status"},{"content":"Assumed knowledge","slug":"assumed-knowledge"},{"content":"Prerequisites","slug":"prerequisites"},{"content":"API details","slug":"api-details"}],"owner":"26985380","collectionId":"25e50936-4560-4515-ab44-358596606ad4","publishedId":"2s93m61MYG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-25T00:39:55.000Z"},"item":[{"name":"DispatchCase","item":[{"name":"Retrieves the Case Data for Dispatch Run","id":"af643f70-c840-4634-b39d-53bdcbc5e88e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-initiatingParticipantId","value":"","type":"text","description":"(Required) The id of the Initiating Participant
\n"},{"key":"x-market","value":"WEM","type":"text","description":"(Required) The id of the market
\n"}],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase/dispatchData?primaryDispatchInterval=Retrieves the Case Data for Dispatch Run
\n","urlObject":{"path":["dispatchData"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase"],"query":[{"description":{"content":"(Required) Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"primaryDispatchInterval","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalStartDate","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalEndDate","value":"(Required) The id of the Initiating Participant
\n"},{"key":"x-market","value":"WEM","type":"text","description":"(Required) The id of the market
\n"},{"key":"Accept","value":"text/plain","type":"text"}],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase/dispatchDataOutcomes?primaryDispatchIntervalFrom=Retrieves Case Data from the Central Dispatch Process through a range of past Primary Dispatch Intervals
\n","urlObject":{"path":["dispatchDataOutcomes"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase"],"query":[{"description":{"content":"(Required) Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"primaryDispatchIntervalFrom","value":"(Required) Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"primaryDispatchIntervalTo","value":"(Required) The id of the Initiating Participant
\n"},{"key":"x-market","value":"WEM","type":"text","description":"(Required) The id of the market
\n"}],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase/preDispatchData?primaryDispatchInterval=Retrieves Case Data from the Central Dispatch Process through a range of past Primary Dispatch Intervals
\n","urlObject":{"path":["preDispatchData"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase"],"query":[{"description":{"content":"(Required) Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"primaryDispatchInterval","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalStartDate","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalEndDate","value":"(Required) The id of the Initiating Participant
\n"},{"key":"x-market","value":"WEM","type":"text","description":"(Required) The id of the market
\n"}],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase/weekAheadDispatchData?primaryDispatchInterval=Retrieves the Case Data for Week Ahead Dispatch Run
\n","urlObject":{"path":["weekAheadDispatchData"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchCase"],"query":[{"description":{"content":"(Required) Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"primaryDispatchInterval","value":"Possible values are Reference,ForecastHigh, ForecastLow. Default value is Reference
\n","type":"text/plain"},"key":"dispatchScenario","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalStartDate","value":"Default date format: yyyy-MM-ddTHH:mm:ss+08:00. For request, the offset +08:00 is optional - api will by default treat incoming time as +08:00
\n","type":"text/plain"},"key":"dispatchIntervalEndDate","value":"