INTERNAL
INTERNAL
25/01/2017
FORMAT
AUDIENCE
DATE
UNCLASSIFIED
CLASSIFICATION
Superannuation Dashboard
Created By <IPMS>
ATO Monitoring – AAAM Integration Design
UNCLASSIFIED
Document Owner: <IPMS>
UNCLASSIFIED
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
ENDORSEMENT/VERSION CONTROL
CURRENT VERSION NUMBER
APPROVAL
[approver’s name]
0.2
[approver’s position]
DATE
[approved/endorsed]
25/01/2017
[date]
VERSION CONTROL
Version
0.1
0.2
Revision date Author
20/12/2016
25/01/2017
Tareq El-mezieni
Leon Partsi
Summary of Change
Initial Version
Epochtime clarification
Document versioning is described in IT Standard 03
DO NOT delete the section break above this page.
UNCLASSIFIED
1.1
PAGE 2 OF 8
UNCLASSIFIED
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
TABLE OF CONTENTS
1
2
Introduction ........................................................................................................................ 4
Interface Specifications ...................................................................................................... 4
2.1 Superannuation Planned outage API Data Mappings .................................................. 5
2.2 Superannuation Announcements API Data Mappings ................................................. 7
2.3 Superannuation Current status API Data Mappings .................................................... 8
When you have completed your document, right mouse click on the table of contents above
and select Update Field to create your table of contents.
DO NOT delete the section break above this page.
UNCLASSIFIED
1.1
PAGE 3 OF 8
UNCLASSIFIED
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
1
INTRODUCTION
2
INTERFACE SPECIFICATIONS
The core objective of this document is to define the output of each API on the ATO
Superannuation dashboard, in order to enable software developers to interepret and utilise
these APIs in their own applications. The ATO Superannuation dashboard exposes 3 APIs for
developer use: one for Planned Outages, one for Announcements and one for Current Service
Status. The following sections will describe the format of each API output.
This section defines data mappings for each of the interfaces of the API data listed in setion 1.
Please note that all time and date is output in epochtime format. Epochtime (also known as
POSIX time or Unix time) is a system for describing instants in time, defined as the number of
seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1
January 1970, not counting leap seconds. It is valuable for developers as it automatically
incorporates daylight savings time and time zones. There are several functions in most
programming languages for converting epochtime into a human readable format.
For more information on epochtime please visit https://en.wikipedia.org/wiki/Unix_time.
SPACE LEFT BLANK INTENTIONALLY
GO TO NEXT PAGE
UNCLASSIFIED
1.1
PAGE 4 OF 8
UNCLASSIFIED
2.1
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
SUPERANNUATION PLANNED OUTAGE API DATA MAPPINGS
The URI that software developers will need to use in order to access the API data for Planned
Outage is:
http://sses.status.ato.gov.au/api_get/plannedOutage
1) The API data for a single planned outage session will be outputted will be in JSON format as
shown below:
{"preview":false,"init_offset":0,"messages":[],"fields":["all_services","end_date"
,"message","start_date"],"rows":[[["SuperTICK 1","SuperTICK 2","SuperTICK
3","SuperMATCH 2","EmployerTick"," SMAT"," FVS","
EPF"],"1482127200","planned outage test","1482105720"]]}
Field
all_services
end_date
message
start_date
UNCLASSIFIED
Description
Sample Data
SuperTICK 1
SuperTICK 2
SuperTICK 3
SuperMATCH 2
EmployerTick
SMAT
FVS
Specifies the end date of the 1482127200
Lists all the services that are
currently undergoing a
planned outage, but does
not necessarily mean all
services are undergoing a
planned outage
planned outage in epoch
time.
Specifies the message that
accompanies the planned
outage, that is set by admin
users
Specifies the start date of
the planned outage in epoch
time
1.1
planned outage test
1482105720
PAGE 5 OF 8
UNCLASSIFIED
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
2) The API data for multiple planned outage sessions will be outputted will be in JSON format as
shown below:
{"preview":false,"init_offset":0,"messages":[],"fields":["all_services","end_date"
,"message","start_date"],"rows":[[["SuperTICK 1","SuperTICK 2","SuperTICK
3","SuperMATCH 2","EmployerTick"," SMAT"," FVS","
EPF"],"1482127200","planned outage test","1482105840"],[["SuperTICK
1","SuperTICK 2","SuperTICK 3","SuperMATCH 2","EmployerTick"," SMAT","
FVS"," EPF"],"1482127200","testing","1482124740"]]}
N.B. The JSON row in blue represents the first row of data and the JSON row in orange
represents the second row of data.
3) The API data for no planned outage sessions will be outputted will be in JSON format as shown
below:
{"preview":false,"init_offset":0,"post_process_count":0,"messages":[],"fields":[]
,"rows":[]}
UNCLASSIFIED
1.1
PAGE 6 OF 8
UNCLASSIFIED
2.2
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
SUPERANNUATION ANNOUNCEMENTS API DATA MAPPINGS
The URI that software developers need to use in order to access the API data for
announcements is:
http://sses.status.ato.gov.au/api_get/announcement
1) The API data for a single announcement will be outputted will be in JSON format as shown
below:
{"preview":false,"init_offset":0,"messages":[],"fields":["datePosted","message",
"title"],"rows":[["1482066000","Drive safely","Happy Holidays"]]}
Field
datePosted
message
title
Description
Sample Data
Specifies the date that the
1482066000
announcement was posted
by admin users in epoch
time
The message that the admin Drive safely
users will post alongside the
announcement
Specifies the announcement Happy Holidays
posted by the admin users
2) The API data for multiple announcements will be outputted will be in JSON format as shown
below:
{"preview":false,"init_offset":0,"messages":[],"fields":["datePosted","messag
e","title"],"rows":[["1482112020","Drive safely","Happy
Holidays"],["1482124200","Enjoy the break","Happy New year"]]}
N.B. The JSON row in blue represents the first row of data and the JSON row in orange
represents the second row of data.
3) The API data for no announcements will be outputted will be in JSON format as shown below:
{"preview":false,"init_offset":0,"post_process_count":0,"messages":[],"fields":[]
,"rows":[]}
UNCLASSIFIED
1.1
PAGE 7 OF 8
UNCLASSIFIED
2.3
SUPERANNUATION DASHBOARD
ATO MONITORING – AIAM INTEGRATION DESIGN
SUPERANNUATION CURRENT STATUS API DATA MAPPINGS
The URI that software developers need to use in order to access the API data for current status
is:
http://sses.status.ato.gov.au/api_get/currentStatus
1) The API data for current status will be outputted will be in JSON format as shown below:
{"preview":false,"init_offset":0,"messages":[],"fields":["Service_Name","Status"
,"time"],"rows":[["SuperTICK 1","Operational","1482187800"],["SuperTICK
2","Partial Availability","1482187800"]]}
Field
Service_Name
Status
time
Description
Specifies the services for
which a status is available
Specifies the current status
of the respective service
Specifies the current epoch
time for which a status is
available for the respective
service
Sample Data
SuperTICK 1
Operational
1482187800
N.B. The Orange JSON row specifies another services with its current status and the
respective epoch time.
2) The API data for no announcements will be outputted will be in JSON format as shown below:
{"preview":false,"init_offset":0,"post_process_count":0,"messages":[],"fields":[]
,"rows":[]}
UNCLASSIFIED
1.1
PAGE 8 OF 8