The Post Operational Product APIs will be interfaced to FASS provider to submit VRE Forecasts, DPV Forecasts and DPV Actuals. Provider will be submitting based on CIM structure.

API status

This page is a work in progress and is not yet final.

Audience

The primary audience is implementers and maintainers of APIs in participant organisations.

The secondary audience is BAs and other interested parties.

Related resources

For additional information, see:

• API Reference

• Connecting to Markets Systems

• Guide to User Rights Management

• National Electricity Rules Glossary

• Industry Terminology

• OpenAPI Specification v3.0.1

Related rules and procedures

• <List all applicable documents>

OpenAPI specification

You can download the OpenAPI Specification for the following environments:

• Pre-production: OpenAPI specification (TBC)

• Production: OpenAPI specification (TBC)

Prerequisites

Before using the Post Operational Product API, see API Requirements in Markets Portal Help. You must also:

• <List any specific prerequisites for the API>

Payload format

This API supports a JSON format payload.

API gateway

Participants can connect to the AEMO API Gateway through the internet. See URL format in the API Reference.

All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

User rights access

Participant administrators provide access to the Operational Forecasting Product API using the entity: … . For more information, see Guide to User Rights Management.

N/A

Authorisation

The API are configured in APIM which will be using AD authentication based on JWT token, however the API when called from APIM application will implement Authentication/Authorization based on AEMO proprietary identity service. The end point will be configured with APIM.

Assumption:

• Data is validated prior to being posted to ODS and NEM. Most of the validation should take place at schema level

Compression

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

Throttling

To control traffic, AEMO implements a throttling limit of 250 requests per minute.

If requests exceed the throttling limit, the payload is rejected.

Response codes

See Response codes in the API Reference.

Submission rules

<Include submission rules if applicable>

Submission interfaces

In addition to the API, you can use the following interfaces: <link to the relevant Markets Portal Help topic>

Submission size

A submission request or response has a payload limit of 10 MB (uncompressed).

Submission processing

< Example: Submissions are processed in the order AEMO receives them. You must ensure the correct submission order so your latest Offer is the Effective Offer Submission acknowledged by AEMO’s systems.>

Submission response

<Example: If the entire submission is valid, you receive a response 200 with transaction ID and other metadata related to the Submission. If your submission has multiple Units and multiple Trading Days in a single request, and one has an error, AEMO rejects the whole submission. If your submission has an error AEMO rejects it with a response code, displaying the source of the problem so you can identify its location. Rectify the issue by updating the values appropriately and resubmitting. Submission details>

Validation

Validation rules:

1. All datetime fields should be in UTC. Format: yyyy-MM-ddTHH:mm:ssZ+00:00

2. Mandatory Headers:

   1. ProviderID

   2. ProviderName

   3. TimeStamp

   4. Market

3. Mandatory Fields:

   1. registeredResource/name

   2. resourceTimeSeries/forecastType

   3. resourceTimeSeries/timeStep

   4. regularTimePoint/value1

   5. regularTimePoint/sequenceTime

   6. regularTimePoint/recordQuality