Variable Parameter

API reference

Fetches records from the Contract_unit_availability table based on search criteria.

API status

Draft for review. The design is not ready for participants’ builds.

Audience

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

The secondary audience is BAs and other interested parties.

For additional information, see:

Related rules and procedures

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 Variable Parameter API, see API Requirements in Markets Portal Help.

Payload format

This API supports a JSON format payload.

Parameters

The variable-parameter-v1 has two end points:

  • get /contractUnitAvailability - query parameters

  • post /contractUnitAvailability - path parameters

API gateway

Participants can connect to the AEMO API Gateway through the internet or MarketNet. 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 Enablement instructions API using the entity:

  • MMS_SSM_AVAIL_WRITE

  • MMS_SSM_INST_VIEW

For more information, see Guide to User Rights Management.

Authorisation

API requests are authorised by Basic HTTP authentication (Basic Auth) using a Base64-encoded username and password. The credentials are assigned by your company’s participant administrator.

In an API request, include the Base64-encoded string in a HTTPS Authorization header. For more information, see Authorisation in the API Reference.

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 TBC.

If requests exceed the throttling limit, the API responds with a HTTP 429 or 422 status.

Participants systems must manage throttling limits. AEMO can also reject multiple API requests for the same participantId at the same time.

Response codes

See Codes in the API Reference.

Submission rules

A submission API request times out at 60 seconds.

Submission interfaces

In addition to the API, you can use the following interfaces: https://markets-portal-help.docs.public.aemo.com.au/Content/System_Security_Scheduler/HowDoYouUse.htm?tocpath=System%20Security%20Scheduler%7CAbout%7C_____3 (Link TBC).

Submission size

A submission request or response has a payload limit of 100 KB (compressed or uncompressed).

Submission processing

TBC

Submission response

TBC

Validation

TBC