MAX API Overview

The Site Controller (sometimes known as the PC-MID) has an API, known as MAX API. MAX API allows Third Party Systems using the API to obtain live state updates for AGMs in the venue and to perform certain actions on AGMs in the venue.

The new CMS monitoring licence in NSW took effect as of 1 December 2017. Under this licence three different AGM communications protocols are supported:

• X-Standard
• QCOM 1.6.6i
• G2S

MAX API is a simple to use API that provides a common interface (independent of the AGM protocol) to provide both a basic data feed capability and subsidiary services similar to those provided by equipment/systems connected via X series AGM data ports.

The API delivers access to a unified model that avoids the need for integrated third party applications to cater specifically for each protocol and enables cross-protocol functionality to be provided by connected systems without regard to the protocol that individual machines in the venue are operating.

By providing these services from a venue API, rather than from individual machines, systems and services that are inherently not AGM based need not provide their own network connections to each AGM.

In addition the API gives access to the monitoring data collected by the Site Controller (PC-MID). This ensures that information similar to that currently obtained via VDA interface is available to Third Party systems.

This documentation describes some of the more detailed/intricate interactions possible between Third Party Systems and AGMs, via the MAX API.

Primarily these descriptions are sequence diagrams, and the documentation provided on this site.

The detailed documentation on the content of individual messages is conatianed in, or included with the message Avro Schema.

Testing of individual integration implementations to the MAX API is possible via the MAX Interoperability Lab (located at Regents Park).

To access the Interoperability Lab and/or enter into MAX API discussions, providers of Third Party Systems are required to enter into an “Approved Party Services Agreement (NSW)” with MAX. The agreement outlines the services (and associated fees) to be provided by MAX (Regulator approval pending).

Once the Agreement has been executed, MAX will then provide Interoperability LAB booking system details.

The “Approved Party Services Agreement (NSW)” is available from the NSW Links Manager (DLNSWLinksManager@tattsgroup.com).