Meter Exemptions

The Meter Exemptions API enables the creation and management of metering exemptions in MSATS.

API status

Ready. The design is ready for participants to use.

Audience

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

The secondary audience is BAs and other interested parties.

Related resources

• Guide to Metering Exemptions

• 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

• Exemption Procedure – Metering Installation Malfunctions

• Meter Exemption Guideline Supplement to the Exemption Procedure

• Metrology Procedure: Part A

• MSDR and MCPI Effective Date Change Process

Prerequisites

Before using the API, see API Requirements in Markets Portal Help.

Payload format

This API supports a JSON format payload.

Response format

The default API response is JSON, but you can request a csv payload for GET requests.

Depending on the Accept header value, the response returns in one of the following formats:

• application/json: JSON schema

• text/csv: csv payload.

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 Metering Exemptions API using the following interactive entities:

• exemptionList: Web Service Get Meter Exemption List

• exemptionDetails: Web Service Get Meter Exemption

• submitExemption: Web Service Submit Meter Exemption

For more information, see Guide to User Rights Management.

Authorization

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, submitExemption has a throttling limit of 1 request per second per participantId.

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 HTTP request in the API Reference.

Submission rules

The following submission rules apply:

1. The entire submission must be valid otherwise it is rejected.

2. The active Metering Coordinator in the NMI must match the Metering Coordinator on the exemption otherwise it is rejected.

Submission interfaces

In addition to the API, you can use the Meter Exemption interface in the Markets Portal. See Guide to Metering Exemptions.

Submission size

The Meter Exemptions API accepts up to 75,000 NMIs in a JSON or csv request payload.

Submission response

Valid requests receive a 200 response and submission related data.

If there is an error in the submission request the API rejects the request and returns a response code with a description of the error. In this case correct the error and resubmit the request.

Validation

submitBids actions

The following table shows valid NMI actions depending on the Meter Exemption action.

Base URLs