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.00.0 Release Notes

Features Xero Integration Xero integration is now available in SELMA. Refer to this post for setup and usage instructions. (This is a paid feature) Canvas Integration Canvas integration is now available. Refer to this post for setup and usage instructions. (This is a paid feature) Moodle Integration Moodle integration is now available. Refer to this …

3.14.0 Release Notes 🥧

Features/Improvements Multi-Select Campus Filter in Grid Reports Added new multi-select filter option for grid reports, allowing users to filter report data to display information for multiple selected campuses, intakes, or other entities simultaneously. This enhancement improves reporting flexibility when analysing data across specific subsets of locations or programmes. Enhanced Class Linking Logic for Enrolment Components …

3.20.0 Release Notes

Features/Improvements Automated Completion Rules Create rules for entire programmes or specific components using criteria like grades, completions and component status. The visual rule builder lets you set execution order, automatically assign grades, update completion status, generate events and more. Column Manager Index views now support role-based column management, allowing administrators to customise which columns are …

3.06.0 Release Notes

Features/Improvements Legal Age Configuration Calendar / Timetable Enhancements Intake and Class Enrolment Improvements Text Messaging Added the TXTStream SMS provider integration for sending text messages to NZ mobile numbers. Bug Fixes Programme to Intake Parent Components Mapping Fixed parent-child component relationships during intake and enrolment creation. Student Index – Search Functionality Timetable Import Time Conversion …