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

Features/Improvements Orders and Quotes New financial workflow capabilities have been added to SELMA: Class Achievement Matrix A new Class Achievement Matrix provides streamlined achievement tracking at the class level. The matrix displays Class Components by default, automatically falling back to Enrolment Components when no Class Components exist. NZ Compliance Enhancements Communication Improvements Scheduler Grid Enhancements …

3.22.0 Release Notes

Features/Improvements UIP Data Export Report Generate UIP submission files directly from SELMA for upload to the Ministry of Education portal. Certificate QR Code Verification Enhancement Certificates with verification QR codes now perform real-time validation against the enrolment each time they are scanned. This ensures data accuracy by reflecting the current enrolment status. If an enrolment …

3.12.0 Release Notes

Features/Improvements Google SSO & Email Integration Added Google login functionality for both staff and students. Users can also link their SELMA user profile to their Gmail account to use their own email within SELMA to send communication emails, providing greater flexibility for personalised communications. CloudAssess Account Management Added unlink users from CloudAssess feature. The user …