Developer portal site map

The site map lists menu pages, as headings, and subjects covered in those pages, underneath. The site map acts as a table of contents for the entire site, to help searches for specific information.

Click on the links to navigate to a topic or scenario.

Getting connected

• Connecting to the STARS Client Integration Environment (sandbox)

• SMS readiness to connect

• Connecting RTOs to STARS Production Environment

Setting up machine-to-machine credentials

• 1. Create a self-signed certificate

• 2. Go to the VET Data Streamlining registration and support page

• 3. VDS Support will create your application registration, and provide you with:

• 4. Validate your machine-to-machine credentials

• Information for SMS suppliers (on the recommended access method)

Programs and subjects configured for your use

• Getting started with reporting training activity during client integration build testing

• Validation behaviour and test considerations

VET Data System Readiness self-assessment

• Assessment scope

• Completing the readiness self-assessment

• Disclaimer

SMS readiness self-assessment capabilities

• 1. Establish an authenticate connection to STARS

• 2. Maintain auditable user authentication

• 3. Submit valid reportable data to STARS

• 4. Reconcile data by reporting period

• 5. Delete STARS data reported in error

• 6. Check the quality of reported data

• 7. Submit end-of-quarter declaration

Business outcomes

• Core business outcomes - what STARS enables

• Standard workflows for business outcomes

• Reporting across jurisdictions and pathways

Reporting obligations and pathways across jurisdictions

• Summary of key terms

• Reporting pathway

• Reporting obligation

• Assessment scope

• Reporting periods

• Jurisdiction

Submit data

• Where submitting valid data fits in the STARS lifecycle

• Available API endpoints

• Simple and complex submission scenarios

• Scenario 1 - Basic workflow using the minimal unit record (MUR)

• Complex submission scenarios

• Enabling automated submission

Scenario - Upload an enrolment (registration)

• Minimal unit record context

• Sequence overview

• Step‑by‑step flow

Scenario - Defer a program enrolment

• Sequence overview

• Sequence diagram

• Step‑by‑step flow

Scenario - Cancel an enrolment

• Sequence overview

• Sequence diagram

• Step‑by‑step flow

Scenario - Handle API failures

• Sequence overview

• Sequence diagram

• Step‑by‑step flow

Automated submissions to STARS

• RTO accountability

• Attribution of submissions

• Solution assurance

Reconciliation

• Where reconciliation fits in the STARS lifecycle

• Available reconciliation endpoints

• How reconciliation retrieval works

• Relationship traversal rules (system behaviour)

• Data returned by reconciliation

• Validation and result handling

• Example scenarios using reconciliation APIs

Submitted in error

• Where void fits in the STARS lifecycle

• Available endpoints

• Sequence overview

Data quality

• Where data quality checks fit into the STARS lifecycle

• Available API endpoints

• What are data quality rules?

• Data quality assessment process

• Data quality assessment lifecycle

• Re-validation and resolution of assessment outcomes

• Working with data quality assessments

• Understanding assessment results

• Relationship between data quality and declarations

Declarations

• Where declarations fit in the STARS lifecycle

• Types of declarations

• Available declaration end points

• How declaration submission works

• POST declaration API

• GET declaration API

APIs

API maturity

• API maturity ratings

• Understanding API maturity

System guidance

• API resources

• Data uploads must include all child objects to date

• Reference data and system rules

• No_value enumerations

• Minimal unit record

• Immutable keys

• Change tracking identifiers

• Transaction batch

• Errors and validation responses

• ProblemDetails

• Pagination

• Whitespace validation rules

• Rate limiting and concurrency

• Request compression

Errors and validation responses

• Understanding validation results

• Validation result attributes

• Complete validation result example

• Resource identification

• Access path

• How to use accessPath

• Validation grouping

• dataSource

• Processing validation results

• Stubbed validation scenarios

Understanding Problem Details responses

• Problem Details and validation results

• Schema validation

• Domain validation

• Other Problem Details responses

• Understanding Problem Details attributes

• Relationship to the STARS rules catalogue

• Processing Problem Details responses

• Summary

Release schedule

• Previous releases