TASS APIs

Version 2

Data can be processed without any restrictions and is based on school providing access to the associated endpoints.

Version 3

Security Roles are required to use the API method, which restricts what information can be accessed.  For specific information on API methods, their versions and any applicable permissions needed, visit our GitHub page.

See ‘Version 3 APIs’ for a list of Certified Partners who use this version.

Accounts Payable Integration (Licence Code: API06)

This Version 2 public API supports third-party OCR scanning and workflow automation software, for the creation of Invoices in TASS.web Finance > Accounts Payable > Supplier Transactions > Invoices without the need for any manual data entry.

The following information can also be extracted by this API:

• Annual budget amounts for GL Accounts.

• Account responsibility levels for GL Accounts.

• Details of the requisition approver/s and raiser.

• Edit the quantity and unit cost of a PO line item.

• Add new PO line items to an existing PO.

Yes

Certified Partners:

• Ellby (previously FileBound)

• Alii Technology Group

• BBC Digital

Matrix of currently certified integration partners.

Assessment (Licence Code: API29)

This Version 3 public API allows users to retrieve the following information:

• Assessment Methods data with validations for a specified year and period. To retrieve all or for a single Assessment Method.

• Result years and periods. To retrieve in bulk or for a specific year.

• Objective data for a supplied year and period.  To retrieve all Academic Reporting Objectives, or for a specific objective.

• Result formats data for a supplied year and period. To retrieve all Result Formats or for a single Report Type.

 The API allows users to upload the following information:

• Student Subject Results (Final Result and Overall Subject Grades). To update the Subject objective results currently available in the Upload Academic Results.

The LMS Integration API must also be enabled to use this API.

No

Boarding (Licence Code: API10)

This Version 3 public API extracts the following information for students who have been flagged as a boarder within TASS.web:

• Student Photo (if enabled in TASS.web).

• Basic Student information.

• Parent Contact information based on a student's communication rules.

Yes

Certified Partners:

• REACH

• Boardingware (also known as Orah)

Matrix of currently certified integration partners.

CeDe3 Integration (Licence Code: API09)

This private API is reserved for use by the Catholic Education Diocese. Contact Customer Care for access.

No

Consent2Go Integration

(Licence Code: API31)

This Version 3 private API allows integration between the third-party application Consent2Go and TASS.

It allows Consent2Go users to retrieve the following information:

• Extra Curricular Activity Group Lists.

• Class Lists.

• Student Details.

  • General tab

  • UD tab

  • UD Area tab

• Student Medical.

  • General tab.

  • Medical Conditions tab.

  • Immunisations tab.

  • Practitioners tab.

• Parent Contact Details (based on the student’s Communication Rules).

• Employee Details.

  • General tab.

  • UD tab.

  • UD Area tab.

The API also allows Consent2Go to upload the following information back into TASS:

• Student Medical.

  • General tab.

  • Medical Conditions tab.

  • Practitioners tab.

• Parent Contact Details.

Yes

Certified Partners:

• Consent2Go

Matrix of currently certified integration partners.

Data Upload Utility (Licence Code: API14)

This Version 2 public API mirrors the functionality available in TASS.web System Admin > Utilities > Data Upload Utility, but instead of updating data via a CSV upload, data is updated via direct passing of information into the database via the API.

Yes

Certified Partners:

• PPC ID Card Solutions

Matrix of currently certified integration partners.

Edumate Integration (Licence Code: API21)

This Version 2 private API extracts the following General Ledger-related information:

• Chart of Accounts.

The following can be updated by this API:

• Basic Student Information.

• Basic Parent Information.

• Parent Contact Information.

• Account Journals.

• Sundry Receipts.

Contact Customer Care for access.

Yes

Certified Partners:

• Edumate

EmployeeHR (Licence Code: API13)

This Version 2 public API enables basic employee records to be submitted using third-party software to be entered into TASS.web Payroll/HRM > Employee/HR > Employee Information > Employees without any manual data entry.

The following information can also be extracted by this API:

• Employee Photo (if enabled in TASS.web).

• HR General tab.

• Address tab.

• Next of Kin.

• Leave Balances.

• HR User Defined information.

Yes

Certified Partners:

• SchoolBox

• PPC ID Card Solutions

Matrix of currently certified integration partners.

General Ledger Analytics (Licence Code: API22)

This Version 3 public API extracts the following General Ledger-related information:

• Chart of Accounts.

• Account Balances for a Year/Period.

• Account Responsibilities.

• Reporting Codes setups and mappings.

• Ledger Transactions for a Year/Period or a Year/Account.

No

Identity Management (IdM) (Licence Code: API23)

This Version 3 public API extracts the following information used with third-party Identity Management Providers:

• Basic Student information.

• Basic Parent Information.

• Basic Employee Information.

• TASS.web User Information.

• LDAP/SAML information for students, parents and employees.

• User Role Management.

The following is also able to be updated by this API:

• Employee Portal Access, User Name and Email Address.

• Student Portal Access, User Name and Email Address.

• TASS.web Portal Access, User Name and Email Address.

• Parent Portal Access and User Name.

For more information, refer to the 'Version 53 - IdM API' video.

Yes

Certified Partners:

• SchoolBox

• K12 Solutions

Matrix of currently certified integration partners.

LEQ Integration (Licence Code: API15)

This is a private API reserved for use by Lutheran Education Queensland. Contact Customer Care for access.

No

Library Integration (Licence Code: API07)

This Version 3 public API extracts the following information required by third-party library management software:

• Student Photo (if enabled in TASS.web).

• Basic Student Information.

• Employee Photo (if enabled in TASS.web).

• Basic Employee Information.

• Teacher Subject Information.

• Student Subject Information.

• Parent Contact Information (based on a student's communication rules).

Yes

Certified Partners:

• Oliver

• Box of Books

Matrix of currently certified integration partners.

LMS Integration (Licence Code: API03)

This Version 3 public API extracts the following information required by third-party learning management system software:

• Student Photo (if enabled in TASS.web).

• Basic Student information.

• Basic Teacher Information.

• Basic Subject Information.

• Timetable Information:

  • Timetable Definitions.

  • Timetable Calendar.

  • Student Timetable information.

  • Teacher Timetable information.

Yes

Certified Partners:

• Canvas

• SchoolBox

• Box of Books

Matrix of currently certified integration partners.

Mobile App (Licence Code: API05)

This Version 3 public API supports third-party Mobile Apps and the following connections:

• Parent login authentication.

• Parent split family access.

• Permissions based on parent access to information in Parent Lounge.

• Student eDiaries and the following feeds:

  • Timetable

  • LMS/Assessment Activities

  • Sports Fixtures

  • Parent-Teacher Interviews

  • Boarders Leave

  • Pastoral Care

  • Personal Calendar

  • Events

• Events details with SSO deep linking to Parent Lounge to action the approval and payment of the event.

• School calendar and daily notices.

• Notifications including targeted Push Notifications generated from Staff Kiosk (LDAP enabled only).

• LDAP mappings can be maintained in TASS.web System Admin > Users > LDAP/SAML Maintenance.

Yes

Certified Partners:

• Digistorm

Matrix of currently certified integration partners.

Notifications (Licence Code: API30)

This Version 3 private API allows third-party vendors to generate push notifications within TASS.web and Staff Kiosk and send them to parents via the Parent Orbit app.

No

Online Enrolments (Licence Code: API04)

This Version 3 public API enables enrolment applications submitted using third-party software to be entered into TASS.web without any manual data entry.

Applications entered using this method will be available for processing using TASS.web Student Admin > Enrolments > Enrolment Information > Online Enrolment Applications.

Online Enrolment Applications can also be uploaded if the school chooses not to connect via this API.

This API allows the school to extract the following details:

• Campuses.

• Enrolled Students.

• Feeder Schools.

• Languages.

• Occupations.

• Parent UD.

• Previous Connections.

• Religions.

• Residency Statuses.

• Students.

• Student UD.

• Student UD Area Setup.

• Year Groups.

• Genders.

• Titles.

Yes

Certified Partners:

• Digistorm

• Blumark

• Enrol HQ

• Enquiry Tracker

Matrix of currently certified integration partners.

Public Calendar and Notices (Licence Code: API11)

This Version 2 public API allows the school to extract the details and attachments of Daily Notices and Calendar Events flagged for visibility in the Public Calendar.

No

School Calendar and Notices (Licence Code: API19)

This Version 2 public API allows the school to extract the following details:

• Daily Notices flagged for visibility in:

  • Staff Kiosk.

  • Student Café.

  • Parent Lounge.

• Calendar Events flagged for visibility in:

  • Staff Kiosk.

  • Student Café.

  • Parent Lounge.

• Teacher eDiary information.

• Student eDiary information.

Yes

Certified Partners:

• SchoolBox

Matrix of currently certified integration partners.

Student Academic Analytics (Licence Code: API17)

This Version 2 public API extracts the following information that can be used to generate analytics using third-party software such as Microsoft BI:

• Basic Subject Information.

• Student Attendance.

• Student Academic Performance.

• Class and/or Cohort statistical data:

  • Average.

  • Maximum.

  • Third quartile.

  • Median.

  • First quartile.

  • Minimum.

• Subject Attendance Rate.

• Standardised Testing.

No

Student Details (Licence Code: API12)

This Version 3 public API extracts the following student-related information:

• Student Photo (if enabled in TASS.web).

• General tab.

• UD tab.

• UD Area tab.

• Parent Contact information based on a student's communication rules.

• MCEECDYA tab.

Yes

Certified Partners:

• Rollcall

• SchoolBox

• K12 Solutions

• My School Connect

Matrix of currently certified integration partners.

App Code

A unique code entered during API setup that the third-party application uses to identify this configuration in API requests.

Lic. Code

A unique code that is used by TASS to identify the TASS API that is in use.

Description

The description of the API that was entered during setup.

App. Server

Details of the originating server for third-party applications. This optional field restricts requests to those from the specified 'Application Server'

Enabled

This column displays 'Y' if the TASS API is enabled, or 'N' if it is not.

HTTPS

This field is set to 'Yes' by default, as all portals are required to have 'Secure Socket Layer (SSL)' applied.

Action

The 'View', 'Edit' and 'Delete' links in the 'Action' column allow you to action existing API Applications.

The ‘Log' link allows you to view a list of connections to the API Application. On the 'API Connections Log’ screen, a list of unsuccessful connections can be listed by checking the 'Unsuccessful Connections only' option. You can also use the 'Print' button to generate a report with a list of connections.

Fields that require further explanation

Application Code

Enter a unique code to identify this Application API.

This is used by the third-party application to identify this configuration in the API request.

Application Description

Enter a description for the API configuration.

Licence Code (Reference)

Select from the picklist provided to choose the API for this configuration.

Licence Codes are for categorisation and reference only. Active API licences are not required.

Application Server

Optional.

This is the originating server for third-party applications and is recommended for a live production environment.

If an 'Application Server' is entered, requests will only be returned if originating from this server.

Use of this setting in conjunction with a proxy server may result in undesired results and/or blocked communication between the two systems.

The application server can be a domain, wildcard domain or IP address.

Token Key

Click the 'Generate' button to insert a Token.

This is a unique token for each TASS API configuration. It is used to secure communication between the TASS server and the third-party system.

Modifying this token will block all API communication that utilises a previously generated token.

HTTPS Only

This field is not editable and will be set to 'Yes'.

TASS.web and all portals are required to have 'Secure Socket Layer (SSL)' applied. This will require an SSL Certificate signed by a Certified Authority (CA).

Enable Photos

The field is only relevant for the following APIs:

• Library Management API.

• Student Details API.

• Employee HR API.

• LMS Integration API.

When enabled, the student/employee photos in TASS will be transferred and used by the third-party system.

Enable JSON Logging

Enabling logging will capture the JSON packets resulting from an API request to be stored for auditing and/or debugging purposes.

Enabling logging for API requests may increase load on your server and impact disk space.

Security Role

Optional.

This field is only applicable for Version 3 and above APIs.

Select from the picklist provided to choose the Security Role to apply the same permissions for this configuration.

Security Roles are maintained in TASS.web System Admin > Users > Security Role Permissions.

Would you like to enable this API?

An API Application can be enabled or disabled using this option.

By enabling this API, you are acknowledging that data from the school's TASS database will be transferred to a third-party software system.