API Changelog

This page documents all API changes across SELMA releases. Each section covers the additions, removals, and modifications to API resources and their properties.

Version 3.28

Modified Resources

Contact

Added properties:

  • portal_contact_can_export_report (?bool)
  • selmaFormSubmissions (Collection)

Component

Added properties:

  • curriculumMaterials (Collection)

Programme

Added properties:

  • curriculumMaterials (Collection)

Document

Added properties:

  • application (?Application)

Version 3.27

Modified Resources

AustraliaEnrolmentExtension

Added properties:

  • confirmation_of_enrolment_number (?string)
  • confirmation_of_enrolment_status (?ConfirmationOfEnrolmentStatusEnum)
  • overseas_student_health_cover_recorded (?bool)
  • cricos_status_reason (?CricosStatusReasonEnum)

Contact

Added properties:

  • preferred_name (?string)
  • phone_mobile (?string)
  • phone_home (?string)
  • phone_work (?string)
  • email_primary (?string)
  • email_secondary (?string)
  • email_school (?string)
  • xero_guid (?string)

Removed properties:

  • preferredName
  • phoneMobile
  • phoneHome
  • phoneWork
  • emailPrimary
  • emailSecondary
  • emailSchool
  • xeroGuid

NewZealandProgrammeExtension

Added properties:

  • total_programme_credits (?int)

ReportBuilderReport

Added properties:

  • base_entity (?ObjectTypeEnum)
  • selects (?string)
  • filters (?string)
  • reportBuilderReportSysuserRoleAssociations (Collection)

Removed properties:

  • report_builder_entity

Version 3.26

Modified Resources

Component

Changed properties:

  • version: ?string → ?int
  • duration: ?string → ?int

Enrolment

Added properties:

  • attendance_percentage (?float)

Removed properties:

  • measure_attendance

Changed properties:

  • cloud_assess_enrolment_id: ?string → ?int

Intake

Changed properties:

  • places_minimum: ?string → ?int
  • places_maximum: ?string → ?int
  • places_forecast: ?string → ?int
  • places_budget: ?string → ?int
  • cloud_assess_intake_id: ?string → ?int

NewZealandEnrolmentExtension

Removed properties:

  • work_based_training_synced
  • public_trust_tuition_start_date
  • public_trust_accommodation_start_date
  • public_trust_living_expenses_start_date
  • public_trust_bailment_start_date
  • public_trust_health_travel_start_date
  • public_trust_submitted_at

NewZealandStudentExtension

Changed properties:

  • work_based_training_synced: ?DateTimeInterface → ?DateTimeImmutable

User

Removed properties:

  • selmaForms

Student

Changed properties:

  • travel_allowance: ?float → ?string

Version 3.25

New Resources

AccommodationProvider

New resource for managing accommodation providers with rooms, bookings, and criteria.

Modified Resources

Address, Campus, EnrolmentComponent, and NZ extension resources updated with new properties. Address campus_id replaced with Campus relation.


Version 3.24

New Resources

OrganisationJobPosition

New resource for managing job positions within organisations.

Placement

New resource for managing student work placements.

TimeSheetEntry

New resource for tracking placement timesheet entries.

Modified Resources

Multiple resources updated with events, placements, and application associations.


Version 3.23

Modified Resources

Contact portal features, commission rules, work-based training fields, and Public Trust integration fields added across multiple NZ resources.


Version 3.22

Modified Resources

EFTS field type changes, SDR exclusion flag, work-based training sync, and quote headers added.


Version 3.20

New Resources

Comment

New resource for event comments with sub-event support.


Version 3.18

Modified Resources

Australian Business Number field and iCal feed token added.


Version 3.17

Modified Resources

Programme report associations added; legacy template fields removed.


Version 3.16

New Resources

IntakeFee, Currency, Tag, and TagAssociation resources added for fee management and entity tagging.


Version 3.15

New Resources

Passport, Visa, and Insurance resources added, replacing legacy flat fields on Student.

Related Articles

3.15.0 Release Notes

Features/Improvements Multiple International Documents Support Students can now store multiple visas, passports, and insurance records instead of being limited to just one of each. This provides better flexibility for managing international student documentation. Students can add, edit, and remove multiple visa, passport, and insurance entries as needed, with student profiles now displaying international documents in …

3.18.0 Release Notes

Features/Improvements Class, Attendance and Grading Permissions Refinement Refined permission controls for class management, attendance and enrolment grading to prevent unauthorised editing by users with view-only access. New Permissions: Google SSO Portal Login Options Added ability to log in with different OAuth credentials for the portal versus admin-side of SELMA. The login email for students can …

3.25.0 Release Notes

New Features Clone Programmes & Components You can now quickly duplicate existing programmes and components while preserving their structure, fees, custom fields, and regional compliance data. Campus Enhancements Campus records can now be linked to an internal organisation (Campus School) and multiple staff members (Managers). Each campus can have an associated address with full address …