Scenario maturity
Submit valid data
API Endpoint Stability: Maturity: 4 – General Availability. API endpoints are available for production use and are considered stable. Breaking changes will be implemented with a new API version. Endpoints may include information about known limitations and any planned enhancements that are not expected to impact existing integrations.
Technical Scenario Completeness: Technical documentation covering the core workflows including upload, validate, handing failed validation failures and submission is covered. Concurrency, advanced validation scenarios and specific lifecycle changes will be updated in a following release.
Business Outcomes and Documentation Completeness: Core business objectives and workflows are documented and may be refined in future releases.
Reconcile previously submitted data
API Endpoint Stability: Maturity: 4 – General Availability. API endpoints are available for production use and are considered stable. Breaking changes will be implemented with a new API version. Endpoints may include information about known limitations and any planned enhancements that are not expected to impact existing integrations.
Technical Scenario Completeness: Technical documentation covering scenarios to support reconciling a due, current, and historical reporting period will be updated in a following release.
Business Outcomes and Documentation Completeness: Core business objectives and workflows are documented and may be refined in future releases.
Remove data submitted in error
API Endpoint Stability: Maturity: 4 – General Availability. API endpoints are available for production use and are considered stable. Breaking changes will be implemented with a new API version. Endpoints may include information about known limitations and any planned enhancements that are not expected to impact existing integrations.
Technical Scenario Completeness: Core workflows documented. Technical documentation to support cascading removal and orphan prevention rules will be updated in a following release.
Business Outcomes and Documentation Completeness: Core business objectives and workflows are documented and may be refined in future releases.
Check data quality
API Endpoint Stability: Maturity 2 - Experimental. API Endpoints for detailed data quality results or contributing resources are available. API Endpoints for data quality summary results will be provided in the next release. SMS suppliers building solutions on the detailed results can commence development. Caveats and expected changes are listed against each endpoint.
Technical Scenario Completeness: Workflows supporting the detailed data quality results are documented. Workflows supporting the summary data quality results and combined detailed and summary data quality results will be published in a following release.
Business Outcomes and Documentation Completeness: Not published
Make a declaration
API Endpoint Stability: Maturity: 2 – Experimental. API Endpoints are stable enough to develop against. Caveats and expected changes are listed against each endpoint.
Technical Scenario Completeness: Partial coverage of core technical scenarios. Changes to API endpoints used in these scenarios is expected to affect basic usage. In the API workflow data quality is expected to precede declarations.
Business Outcomes and Documentation Completeness: Core business objectives and workflows are documented and may be refined in future releases.
Synchronise reference data
API Endpoint Stability: Maturity: 4 – General Availability. API endpoints are available for production use and are considered stable. Breaking changes will be implemented with a new API version. Endpoints may include information about known limitations and any planned enhancements that are not expected to impact existing integrations.
Technical Scenario Completeness: Core technical scenarios are complete. Documentation will be developed to clarify how specific data should be treated in future releases. But the core workflows a client needs to implement will not change.
Business Outcomes and Documentation Completeness: Core business objectives and workflows are documented and may be refined in future releases.
API maturity - scenarios and endpoints
Select a topic to navigate
POST /vet-provider/v1/{jurisdiction}/transaction-batch
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/submit
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: will change. Submitting a transaction batch involves a number of background processes to complete. These are being handed by a basic message queue. Scaling is being improved in future releases to reduce the latency for small transaction batches.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/validate
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: will change. Validating a transaction batch involves a number of background processes to complete. These are being handed by a basic message queue. Future releases will run validation of transaction batches in parallel – ordering of processing is not guaranteed.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/validate
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/validate
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/failed-validation-results
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Endpoint maturity
Transaction Batch
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/student
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/student
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/student/{studentUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/student/{studentUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Student
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/deliverylocation
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/deliverylocation
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/deliverylocation/{deliveryLocationUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/deliverylocation/{deliveryLocationUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Delivery Location
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/program
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/program
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/program/{programUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/program/{programUID
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Program
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programoffering
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programoffering
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programoffering/{programOfferingUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programoffering/{programOfferingUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Program Offering
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programenrolment
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programenrolment
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programenrolment/{programEnrolmentUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/programenrolment/{programEnrolmentUID}
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: C Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Program Enrolment
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subject
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subject
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subject/{subjectUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subject/{subjectUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Subject
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectoffering
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectoffering
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectoffering/{subjectOfferingUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectoffering/{subjectOfferingUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Subject Offering
POST /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectenrolment
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectenrolment
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectenrolment/{subjectEnrolmentUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
DELETE /vet-provider/v1/{jurisdiction}/transaction-batch/{transactionBatchToken}/subjectenrolment/{subjectEnrolmentUID}
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Subject Enrolment
GET /vet-provider/v1/search-by-period
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
POST /vet-provider/v1/uid-match
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/{resourceType}/{uid}/related-resources
Maturity: 4 - General Availability
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: may change. The rules for which resources are returned could change. The behaviour could change significantly in stage 2 between each jurisdiction.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
Reconciling submitted data
Reporting Period (Data quality)
POST /vet-provider/v1/reporting-period/{jurisdiction}/{reportingPeriodNumber}/validate
Maturity: 2 - Experimental
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: will change. Validating a reporting period involves background processing. These processes are being handed by a basic message queue. Future releases will run validation in parallel – ordering of processing is not guaranteed.
Scenarios: The optional technical scenarios are described. Core technical scenarios will be developed in a future release.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
GET /vet-provider/v1/reporting-period/{jurisdiction}/{reportingPeriodNumber}/validate
Maturity: 2 - Experimental
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: The optional technical scenarios are described. Core technical scenarios will be developed in a future release.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
DELETE /vet-provider/v1/reporting-period/{jurisdiction}/{reportingPeriodNumber}/validate
Maturity: 2 - Experimental
Interface stability: not expected to change.
Contract stability: not expected to change.
Value completeness: not expected to change.
Behaviour stability: not expected to change.
Scenarios: The optional technical scenarios are described. Core technical scenarios will be developed in a future release.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
GET /vet-provider/v1/reporting-period/{jurisdiction}/{reportingPeriodNumber}/failed-validation-results
Maturity: 2 - Experimental
Interface stability: will have an alternate route added. An additional failed validation summary results route will be added to support returning a summary representation of quality results.
Contract stability: expected to change. The next major release will include a summary version of data quality results. Some changes to the contract will be made to align the summary and detailed results.
Value completeness: expected to change. The next major release will include a summary version of data quality results. Some changes to the values used will be made to align the summary and detailed results.
Behaviour stability: expected to change. The next major release will include a summary version of data quality results. This will change the visibility of Assessment Groupings.
Scenarios: The optional technical scenarios are described. Core technical scenarios will be developed in a future release.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
Declarations
POST /vet-provider/v1/declaration
Maturity: 2 - Experimental
Interface stability: not expected to change.
Contract stability: expected to change. SegmentId will be removed.
Value completeness: expected to change. Expect declaredOn to use UTC time and the formatting of the date string to change accordingly.
Behaviour stability: expected to change. Enhancements to data quality workflows will change the behaviour of declarations. Missed reporting periods should be declared sequentially using the same end user declaration. These changes should leave the core workflows unchanged. GET should always be called before the POST to check current state before updating.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
GET /vet-provider/v1/declaration
Maturity: 2 - Experimental
Interface stability: not expected to change.
Contract stability: expected to change. segmentId, dateOfDeclaration and declarationDueDate will be removed. declaredOn will be changed to use UTC time and the formatting of the date string to change accordingly. declarationDueDate should be determined using the reporting-period reference data API.
Note: dateOfDeclaration is a duplicate of declaredOn, so whilst this specific field is being removed, the capture and storage of this information will be retained via the remaining field.
Value completeness: expected to change. Expect declaredOn to use UTC time and the formatting of the date string to change accordingly.
Behaviour stability: expected to change. Currently synthetic results are created for undeclared reporting periods to return the declarationDueDate.
Scenarios: Core technical scenarios are described and variations will be provided in following releases.
Change strategy: Changes will be delivered within the current API version (no version split at this stage).
Reference data
GET /vet-provider/v1/reference-data/program
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/subject
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/specialisation
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/superseded-program
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/superseded-subject
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/occupation
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/occupation-version
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/field-of-education
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/level-of-education
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/country
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described; end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/state
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/language
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/reporting-period
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: expected to change. In future releases we may introduce jurisdictional specific reporting periods.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/registered-training-organisation
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/rto-program-scope
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/rto-subject-scope
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may choose to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described; end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/reference-data/lifecycle-student-status-transition
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.
GET /vet-provider/v1/classification
Maturity: 4 – General Availability
Interface stability: not expected to change.
Contract stability: expected to change. A deleted indicator will be added in R9. This is a non-breaking change.
Value completeness: not expected to change.
Behaviour stability: expected to change. The clients may wish to implement a solution to handle the deleted indicator.
Scenarios: Core technical scenarios are described, end‑to‑end coverage is complete. Descriptions of the data sets, their attributes, and the handling of record lifecycle states (including effective-dated, end-dated and deleted records) will be improved in future releases.
Change strategy: Changes will be delivered with a new API version and/or gradual phase out.