Vendor Release Overview/Details 

Standard Releases

A Standard release is to be scheduled every 3 months to allow for enhancements and bug fixes to be rolled out for the PRISMS APIs.

This should provide adequate time for vendors to manage their planning, implementation and testing of any changes prior to release into production.

This may be modified around holidays seasons like Christmas due to staff shortages in the Vendor organisations and DE/DEWR.

Wherever possible these will incorporate any breaking changes, regulatory and legislative changes and any Cyber required changes.

Special Releases

Regulatory and legislative changes will typically have specific date to be implemented by and may not coincide with the 3 month release cycle. 

In some instances they may be within the 3 month cycle time bearing in mind the DE/DEWR team needs to make production ready changes before they can be released into Staging   

Cyber changes or other urgent fixes may need to be rolled out ASAP,  some requiring no Vendor changes and others that will.  

Where urgent releases do not provide sufficient time for Vendors to make their changes.  We may be able to isolate the specific instances and in these instances a request to have these CoE or SVCs entered manually by the providers in the PRISMS UI.

Any Special Releases changes will be communicated and closely managed between the vendors and DE/DEWR.

Service request response times

Service requests that can be answered by the PRISMS API Support Team will usually be responded to within approximately 1-2 working days.

Correction

Please note for the “Create and approve a Confirmation of Enrolment" documentation in the APIs tab, the statement “and sector is not School or VET” does not apply for the following:

initialPrePaidTuitionFromDate - description states

Initial Pre-Paid Tuition From Date

The date for which the tuition period for the initial prepaid fee begins.

Required when the provider is not public or is not listed as Table A in the Higher Education Support Act 2003 (HESA), unless 'initialPrepaidTuitionFee' is $0.

Must be within 'proposedCourseStartDate' and 'proposedCourseEndDate'.

initialPrePaidTuitionToDate – description states:

Initial Pre-Paid Tuition To Date

The date for which the tuition period for the initial prepaid fee ends.

Required when the provider is not public or is not listed as Table A in the Higher Education Support Act 2003 (HESA).

Must be within 'proposedCourseStartDate' and 'proposedCourseEndDate'."

v1.0

Staging environment: 4 December 2024

Production: 5 December 2024

Version: 1.0

 New

List Student Course Variations (SCVs) submitted on a CoE

 Fixes

Create CoE functionality`POST https://gateway.api.np.prisms.education.gov.au/test/Providers/v1/providers/{providerCode}/confirmation-of-enrolments`

  • Correct validation rules for Nominated Welfare End Date (`nominatedWelfareEndDate`)

 Create SCV functionality

v1.0 - PRISMS API Production Release

 Staging Environment: 11 October 2024

Production Environment: 25 October 2024 

Version: 1.0

 This is the first official release of the PRISMS API following the Beta program. 

 API functionality part of this official launch are listed below.

 Submission of student and enrolment data

  • Create and approve a Confirmation of Enrolment

  • Find or create a student

  • Cancel a CoE as the student has left the provider

  • Cancel a CoE due to non-commencement of studies

  • Cancel a CoE due to student Cessation of studies

  • Cancel an Approved CoE due to Admin error

Provider data retrieval and validation

  • Get a single Confirmation of Enrolment

  • Get the certificate for a confirmation of enrolment

  • Get the welfare letter for a Confirmation of Enrolment

  • Get a single agent for a provider

  • Get a single course for a provider

  • Get a single location for a provider

  • Get courses for a provider

  • Get the agents for the provider

  • List a provider's locations

  • List the courses at a provider's location

  • List the locations for a provider's course

  • Validate the message for creating a Confirmation of Enrolment

Reference data retrieval

  • List valid active types

  • List valid agent sort fields

  • List valid agent types

  • List valid Australian states and territories

  • List valid CoE statuses

  • List valid countries for addresses

  • List valid countries of birth

  • List valid course broad fields of education

  • List valid course detailed fields of education

  • List valid course languages

  • List valid course levels

  • List valid course sectors

  • List valid course sort fields

  • List valid course statuses

  • List valid English test exemption reasons

  • List valid English test OET score types

  • List valid English test types

  • List valid genders

  • List valid IELTS English test scores

  • List valid location sort fields

  • List valid location types

  • List valid narrow fields of education.

  • List valid OET English test grades.

  • List valid OSHC providers

  • List valid 'other' forms of English testing

  • List valid payment in arrears types

  • List valid regulator

  • List valid student nationalities

  • List valid titles

  • List valid welfare types of stay

  • List valid work component types

Beta 6 - Release Date: 20 September 2024

 Summary

  • Name: Staging Beta 6 (Open Beta 2)

  • Date: 20 September 2024

  • Environment: Staging

  • Version: 0.6.0

  • Hash: bcf22bc8

  • Status: Released to Staging

Overview

This release brings:

  • A (breaking) change to CoE Creation through the API

  • Shortened lifetime of the access tokens used to access API functions

  • New functionality allowing for the submission of select student course variations (SCVs) into PRISMS

  • A minor fix to the CoE certificate

Breaking Changes

Create and Approve a Confirmation of Enrolment

POST /v1/providers/{providerCode}/confirmation-of-enrolments

  • CoE student is now specified using new mandantory field student.studentId instead of searchStudent.

  • The searchStudent parameters are no longer captured. The internal student search operation has been removed (and replaced by the new Find or Create Student function).

  • The following student details are no longer captured.

    • titleCode

    • firstName

    • secondName

    • familyName

    • genderCode

    • dateOfBirth

    • hasOnlyOneName

    • countryOfBirthCode

    • nationalityCode

  • Notes:

    • The new Find or Create Student function (POST /v1/providers/{providerCode}/students) can be used to retrieve a studentId for CoE creation

    • The Swagger OpenAPI specification on the portal has not yet been updated to remove obsolete fields specified above. Changes to the Swagger are planned for a future release.

Access Token Expiry

  • Access token expiry has been set to 20 minutes for security purposes.

  • The lifetime of an access token can be extended up to 24 hours using refresh tokens. The Developer Attended Authentication Flow Guide has been updated with guidance.

New

Find or Create Student Function

POST /v1/providers/{providerCode}/students

  • Endpoint created to Find a student, or Create a student when search returns no result

  • Returns a studentId which can be used for CoE creation

  • Replaces the internal search or create student capability from the confirmation-of-enrolments endpoint

  • Supports finding students by:

    • StudentId (an encoded representation of student resourceId)

    • CoeCode

    • VisaGrantNumber

    • A combination of PassportNumber and NationalityCode

  • Where a student record is found using the specified search parameter/s, the given student details (e.g. firstName, familyName, dateOfBirth) are validated to ensure no conflicts in details exist

  • Otherwise where no student record is found, the given student details are used to create a new student record

Student Course Variation (SCV) Functions

New functions have been introduced to allow the submission of SCVs for the following reasons:

  • Non-commencement of studies

    • PUT v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/cancellation/non-commencement-of-studies

  • Student notifies cessation of studies

    • PUT /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/termination/notified-cessation-of-studies

  • Student left provider – transferred to course at another provider

    • PUT v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/termination/student-has-left-provider

As per the PRISMS UI, submission of any of these SCVs on a CoE will result in its cancellation. All preconditions, postconditions, inputs and outputs for these functions are consistent with the PRISMS UI.

Fixes

GET /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/certificate

  • Updated to align with Prisms UI for Certificate generation for CoEs having Other Forms English Testing information

 

Beta 5 - Release Date: 09 July 2024

Summary

  • Name: Staging Beta 5 (Open Beta 1)

  • Date: 9 July 2024

  • Environment: Staging

  • Version: 0.5.0

  • Hash: 61dfa2c5

  • Status: Released to Staging (tbc)

Overview

This release brings documentation, validation and messaging improvements and a new endpoint.

New

  • Submit a Change to CoE/Student Details Student Course Variation (SCV). This function is used to cancel an Approved CoE due to an administration error.

    PUT /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/cancellation/administrationerror

Changes

Create CoE Operation (POST /providers/{providerCode}/confirmation-of-enrolments/)

  • Breaking Change: Validation of student passport number (passportNumber) has now been hardened to improve data quality.

  • Other forms of testing (otherFormsOfTesting) is no longer required to create a CoE.

  • Breaking Change: Visa grant number (visaGrantNumber) is now required for onshore CoE's (isStudentOnshore).

Updates to Error Messages

Error messages have now been rewritten to be end 'user-centric'.

Messages will no longer refer to API request property names. Rather, they are designed so that Admissions and Student Management Systems will be able to present these errors to their provider end users without need for translation.

OpenAPI Documentation Updates

Open API documentation have been enhanced to better describe API usage. Further enhancements are planned in this space.

activeTypeCode Query Support for Reference Endpoints

Support to filter on active and/or inactive (activeTypeCode) reference codes have now been extended to all reference endpoints

Beta 4 - Release Date: 09 May 2024

Summary

  • Name: Staging Beta 4

  • Date: 9 May 2024

  • Environment: Staging

Overview

This release brings features and fixes to functionality to API operations related to creating and retrieving CoEs. Please note the breaking changes.

Changes

Create CoE operation (POST /providers/{providerCode}/confirmation-of-enrolments/)

  • Breaking Change: CoE location is now specified using locationID instead of locationName.

  • Breaking Change: CoE agent is now specified using agentID instead of agentDetails.

  • Standard 7 rules are now enforced. CoEs can no longer be created if they conflict with any of the students’ Standard 7 transfer restricted enrolments.

Note: locationId and agentId can be obtained from the GET Locations and GET Agents operations

Get CoE information operation (GET /providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode})

  • locationId, agentId and studentID properties have been added.

  • HATEOAS links have been added.

  • Retrieving ‘Cancelled’ and ‘Expired’ CoE information is now supported.

Get CoE certificate operation (GET /providers/{providerCode}/confirmation-of-enrolments/)

  • Retrieving CoE certificates for ‘Cancelled’ and ‘Expired’ CoEs is now supported.

Get welfare letter operation (GET /providers/{providerCode}/confirmation-of-enrolments/)

  • Retrieving welfare letters for ‘Cancelled’ and ‘Expired’ CoEs is now supported.

Beta 3 - Release Date: 19 March 2024

• Name: Staging Beta 3
• Date: 19 March 2024
• Environment: Staging

Overview

We've been continuing to progress the API functionality that will allow for CoEs to be issued through the API.
This release includes:
• changes to the Create CoE API function as part of ongoing development work to align with the PRISMS UI

  • apply 'visa copy' from student visa to the CoE where applicable

  • enforce provider capacity. A CoE can no longer be created for a provider if their enrolments for the period exceed their approved capacity.

• new data retrieval functions to support CoE Creation

  • courses, locations, agents, CoEs

  • relevant reference endpoints

• new functions to retrieve CoE certificates and CAAW letters

Changes

Visa Copy Save

Once visa copying process is validated, this work component will save retro and non-retro CoEs for both ESOS and NON-ESOS 'ESOSStatusRefCode' into the DB.

Provider Capacity

This feature will check Provider Conditions for stopping a COE Creation, that is, whether the capacity exceeds for a specific provider.

New

Endpoints: Confirmation of Enrolments

• Get a single confirmation of enrolment.
• GET /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}
• Get the certificate for a confirmation of enrolment.
• GET /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/certificate
• Get the welfare letter for a confirmation of enrolment.
• GET /v1/providers/{providerCode}/confirmation-of-enrolments/{confirmationOfEnrolmentCode}/welfare-letter

Endpoints: Courses

• Get the courses for the provider.
• GET /v1/providers/{providerCode}/courses
References:
GET /v1/references/course-levels
GET /v1/references/fields-of-education-broad
GET /v1/references/fields-of-education-narrow
GET /v1/references/fields-of-education-detailed
GET /v1/references/course-sorting-columns
• Get the course for the provider code and course identifier.
• GET /v1/providers/{providerCode}/courses/{courseCode}
References:
GET /v1/references/course-sectors
GET /v1/references/course-statuses
GET /v1/references/course-levels
GET /v1/references/regulators
GET /v1/references/fields-of-education-broad
GET /v1/references/fields-of-education-narrow
GET /v1/references/fields-of-education-detailed
GET /v1/references/course-languages
GET /v1/references/work-component-types
• Get the courses for the provider and location.
• GET /v1/providers/{providerCode}/locations/{locationId}/courses
References:
GET /v1/references/course-levels
GET /v1/references/fields-of-education-broad
GET /v1/references/fields-of-education-narrow
GET /v1/references/fields-of-education-detailed
GET /v1/references/course-sorting-columns

Endpoints: Locations

• Get the locations for the provider.
• GET /v1/providers/{providerCode}/locations
References:
GET /v1/references/location-sorting-columns
• Get the location for the provider code and location identifier.
• GET /v1/providers/{providerCode}/locations/{locationId}
References:
GET /v1/references/location-types
GET /v1/references/states
GET /v1/references/countries
• Get the locations for the provider and course.
• GET /v1/providers/{providerCode}/courses/{courseCode}/locations
References:
GET /v1/references/location-types
GET /v1/references/location-sorting-columns
GET /v1/references/states

Endpoints: Agents

• Get the agents for the provider.
• GET /v1/providers/{providerCode}/agents
References:
GET /v1/references/agent-types
GET /v1/references/agent-sorting-columns
GET /v1/references/countries
GET /v1/references/states
• Get the agent for the provider code and agent identifier.
• GET /v1/providers/{providerCode}/agents/{agentId}
References:
GET /v1/references/states
GET /v1/references/agent-types
GET /v1/references/countries

Endpoints: References

• List references for Agent sorting columns.
• GET /v1/references/agent-sorting-columns
• List references for Broad Field of Education.
• GET /v1/references/fields-of-education-broad
• List references for Course Language.
• GET /v1/references/course-languages
• Retrieve a list of Course Levels.
• GET /v1/references/course-levels
• List references for Course Sectors.
• GET /v1/references/course-sectors
• List references for Course sorting columns.
• GET /v1/references/course-sorting-columns
• Retrieve a list of Course Statuses.
• GET /v1/references/course-statuses
• List references for Detailed Field of Education.
• GET /v1/references/fields-of-education-detailed
• List references for Location sorting columns.
• GET /v1/references/location-sorting-columns
• List references for Location Types.
• GET /v1/references/location-types
• List references for Narrow Field of Education.
• GET /v1/references/fields-of-education-narrow
• List references for Payment in Arrears.
• GET /v1/references/payment-in-arrears
• List references for Regulators.
• GET /v1/references/regulators
• List references for Work Component Types.
• GET /v1/references/work-component-types

Beta 2 - Release Date: 23 Oct 2023

Release

  • Name: Staging Beta 2

  • Date: 23 November 2023

  • Environment: Staging

Changes

  • Create CoE

    • Under 18 validation and Saving - Guardian info and Welfare Details - this feature covers the specification, development and testing of the guardian, and welfare details validation, and saving of the welfare and guardian details for the Create Approved CoE API.

    • Retrospective Coe Saving - this feature is to allow retrospective CoEs to be entered through the API.

    • Course Validation Changes - this change is to validate the "Schedule5RoyalAssentDate" of "2015-12-14" for the Proposed Course Start Date and Proposed Course End Date.

    • Visa Copy Validation - this feature is to ensure existing visa copying processing is applied to CoEs created through the API. (Saving part is still outstanding, only validation is done and released for this release)

  • Authorization changes

    • Attended Flow - additionally, PRISMS UI allows a user to access multiple Providers via grants to selected Roles and/or Permissions.

Beta 1 - Release Date: 10 Oct 2023

Release

  • Name: Staging Beta 1

  • Date: 10 October 2023

  • Environment: Staging

Changes

  • Providers API:

    • Provider and Course data validation.

    • Student Input Validation.

    • Course Details and Location validation.

    • Student Contact and Address Input Validation.

    • Student Identification and attribute matching.

    • Course Fees Validation.

    • OSHC Validation.

    • Agent Identification.

    • Agent Details Validation.

    • Student's English Language Proficiency Validation.

    • Save CoE.

    • Visa Number and Certificate comments validation.

    • POST Approve CoE endpoint.

    • POST Validate Approve CoE endpoint.

  • Reference GET endpoints supporting the Approve CoE endpoints.

    • Reference Data for States.

    • Reference Data for Countries.

    • Reference Data for Countries of Birth.

    • Reference Data for Overseas Health Care Providers.

    • Reference Data for Titles.

    • Reference Data for Welfare Types of Stay.

    • Reference Data for English Test Exemption Reasons.

    • Reference Data for English Test Other Types.

    • Reference Data for OET English Test Grade Value Types.

    • Reference Data for English Test OET Score Types for English Test Types.

    • Reference Data for IELTS English Test Type Scores.

    • Reference Data for English Test Types.

    • Reference Data for Genders.

    • Reference Data for Nationalities.