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.33

Modified Endpoints

GET /api/students

Added parameters:

  • status
  • status[]
  • created_at[before]
  • created_at[strictly_before]
  • created_at[after]
  • created_at[strictly_after]
  • updated_at[before]
  • updated_at[strictly_before]
  • updated_at[after]
  • updated_at[strictly_after]

Version 3.32

New Endpoints

  • /api/australia_basis_for_admissions
  • /api/australia_basis_for_admissions/code/{code}
  • /api/australia_basis_for_admissions/{id}
  • /api/australia_campus_operation_types
  • /api/australia_campus_operation_types/code/{code}
  • /api/australia_campus_operation_types/{id}
  • /api/australia_commonwealth_scholarship_statuses
  • /api/australia_commonwealth_scholarship_statuses/code/{code}
  • /api/australia_commonwealth_scholarship_statuses/{id}
  • /api/australia_commonwealth_scholarship_termination_reasons
  • /api/australia_commonwealth_scholarship_termination_reasons/code/{code}
  • /api/australia_commonwealth_scholarship_termination_reasons/{id}
  • /api/australia_commonwealth_scholarship_types
  • /api/australia_commonwealth_scholarship_types/code/{code}
  • /api/australia_commonwealth_scholarship_types/{id}
  • /api/australia_course_fees_codes
  • /api/australia_course_fees_codes/code/{code}
  • /api/australia_course_fees_codes/{id}
  • /api/australia_course_of_study_types
  • /api/australia_course_of_study_types/code/{code}
  • /api/australia_course_of_study_types/{id}
  • /api/australia_credit_bases
  • /api/australia_credit_bases/code/{code}
  • /api/australia_credit_bases/{id}
  • /api/australia_hdr_end_user_engagements
  • /api/australia_hdr_end_user_engagements/code/{code}
  • /api/australia_hdr_end_user_engagements/{id}
  • /api/australia_hdr_field_of_researches
  • /api/australia_hdr_field_of_researches/code/{code}
  • /api/australia_hdr_field_of_researches/{id}
  • /api/australia_highest_attainments
  • /api/australia_highest_attainments/code/{code}
  • /api/australia_highest_attainments/{id}
  • /api/australia_highest_education_parents
  • /api/australia_highest_education_parents/code/{code}
  • /api/australia_highest_education_parents/{id}
  • /api/australia_highest_qualifications
  • /api/australia_highest_qualifications/code/{code}
  • /api/australia_highest_qualifications/{id}
  • /api/australia_highest_qualification_places
  • /api/australia_highest_qualification_places/code/{code}
  • /api/australia_highest_qualification_places/{id}
  • /api/australia_loan_statuses
  • /api/australia_loan_statuses/code/{code}
  • /api/australia_loan_statuses/{id}
  • /api/australia_maximum_student_contributions
  • /api/australia_maximum_student_contributions/code/{code}
  • /api/australia_maximum_student_contributions/{id}
  • /api/australia_mode_of_attendances
  • /api/australia_mode_of_attendances/code/{code}
  • /api/australia_mode_of_attendances/{id}
  • /api/australia_offshore_deliveries
  • /api/australia_offshore_deliveries/code/{code}
  • /api/australia_offshore_deliveries/{id}
  • /api/australia_principal_offshore_deliveries
  • /api/australia_principal_offshore_deliveries/code/{code}
  • /api/australia_principal_offshore_deliveries/{id}
  • /api/australia_prior_degrees
  • /api/australia_prior_degrees/code/{code}
  • /api/australia_prior_degrees/{id}
  • /api/australia_prior_hep_subdegrees
  • /api/australia_prior_hep_subdegrees/code/{code}
  • /api/australia_prior_hep_subdegrees/{id}
  • /api/australia_prior_other_qualifications
  • /api/australia_prior_other_qualifications/code/{code}
  • /api/australia_prior_other_qualifications/{id}
  • /api/australia_prior_postgraduates
  • /api/australia_prior_postgraduates/code/{code}
  • /api/australia_prior_postgraduates/{id}
  • /api/australia_prior_rto_secondaries
  • /api/australia_prior_rto_secondaries/code/{code}
  • /api/australia_prior_rto_secondaries/{id}
  • /api/australia_prior_secondary_schools
  • /api/australia_prior_secondary_schools/code/{code}
  • /api/australia_prior_secondary_schools/{id}
  • /api/australia_prior_vet_awards
  • /api/australia_prior_vet_awards/code/{code}
  • /api/australia_prior_vet_awards/{id}
  • /api/australia_prior_vet_subdegrees
  • /api/australia_prior_vet_subdegrees/code/{code}
  • /api/australia_prior_vet_subdegrees/{id}
  • /api/australia_recognition_of_prior_learnings
  • /api/australia_recognition_of_prior_learnings/code/{code}
  • /api/australia_recognition_of_prior_learnings/{id}
  • /api/australia_special_course_types
  • /api/australia_special_course_types/code/{code}
  • /api/australia_special_course_types/{id}
  • /api/australia_student_statuses
  • /api/australia_student_statuses/code/{code}
  • /api/australia_student_statuses/{id}
  • /api/australia_summer_winter_schools
  • /api/australia_summer_winter_schools/code/{code}
  • /api/australia_summer_winter_schools/{id}
  • /api/australia_tac_offer_codes
  • /api/australia_tac_offer_codes/code/{code}
  • /api/australia_tac_offer_codes/{id}
  • /api/australia_type_of_attendances
  • /api/australia_type_of_attendances/code/{code}
  • /api/australia_type_of_attendances/{id}
  • /api/australia_unit_of_study_statuses
  • /api/australia_unit_of_study_statuses/code/{code}
  • /api/australia_unit_of_study_statuses/{id}
  • /api/australia_work_experience_in_industries
  • /api/australia_work_experience_in_industries/code/{code}
  • /api/australia_work_experience_in_industries/{id}
  • /api/australia_year12_results_types
  • /api/australia_year12_results_types/code/{code}
  • /api/australia_year12_results_types/{id}

New Resources

AustraliaBasisForAdmission

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCampusOperationType

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCommonwealthScholarshipStatus

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCommonwealthScholarshipTerminationReason

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCommonwealthScholarshipType

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCourseFeesCode

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCourseOfStudyType

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaCreditBasis

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHdrEndUserEngagement

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHdrFieldOfResearch

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHighestAttainment

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHighestEducationParent

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHighestQualification

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaHighestQualificationPlace

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaLoanStatus

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaMaximumStudentContribution

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaModeOfAttendance

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaOffshoreDelivery

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPrincipalOffshoreDelivery

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorDegree

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorHepSubdegree

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorOtherQualification

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorPostgraduate

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorRtoSecondary

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorSecondarySchool

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorVetAward

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaPriorVetSubdegree

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaRecognitionOfPriorLearning

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaSpecialCourseType

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaStudentStatus

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaSummerWinterSchool

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaTacOfferCode

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaTypeOfAttendance

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaUnitOfStudyStatus

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaWorkExperienceInIndustry

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

AustraliaYear12ResultsType

Properties:

  • id (integer)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

Modified Resources

AustraliaCampusExtension

Added properties:

  • aus_campus_operation_type (string)

AustraliaComponentExtension

Added properties:

  • aus_work_experience_in_industry (string)
  • eftsl (string)
  • discipline_code (string)
  • aus_summer_winter_school (string)

AustraliaEnrolmentComponentExtension

Added properties:

  • aus_mode_of_attendance (string)
  • eftsl (string)
  • aus_maximum_student_contribution (string)
  • amount_charged (string)
  • discipline_code (string)
  • unit_of_study_census_date (date-time)
  • aus_student_status (string)
  • loan_fee (string)
  • help_loan_amount (string)
  • credit_used_value (string)
  • aus_credit_basis (string)
  • credit_provider_code (string)
  • unit_of_study_commencement_date (date-time)
  • unit_of_study_outcome_date (date-time)
  • unit_of_study_year_long (boolean)
  • aus_unit_of_study_status (string)

AustraliaEnrolmentExtension

Added properties:

  • aus_type_of_attendance (string)
  • specialisation_code (string)
  • hdr_thesis_submission_date (date-time)
  • aus_hdr_end_user_engagement (string)
  • aus_hdr_primary_field_of_research (string)
  • aus_hdr_secondary_field_of_research (string)
  • rtp_stipend_amount (string)
  • hdr_days_of_engagement (integer)

AustraliaOrganisationExtension

Added properties:

  • aou_code (string)

AustraliaProgrammeExtension

Added properties:

  • aus_course_of_study_type (string)
  • aus_special_course_type (string)
  • course_of_study_load (string)
  • combined_course_indicator (boolean)
  • indicative_student_contribution (string)
  • indicative_tuition_fee (string)
  • aus_course_fees_code (string)
  • aus_principal_offshore_delivery (string)
  • aus_offshore_delivery (string)
  • standard_course_duration (string)
  • cricos_code (string)

AustraliaStudentExtension

Added properties:

  • aus_basis_for_admission (string)
  • year_of_arrival (integer)
  • tax_file_number (integer|string)
  • chessn (string)
  • aus_highest_education_parent_1 (string)
  • aus_highest_education_parent_2 (string)
  • selection_rank (string)
  • aus_highest_attainment (string)
  • atar (string)

Document

Added properties:

  • sys_class (string)

NewZealandComponentExtension

Added properties:

  • exclude_from_nzqa (boolean)

NewZealandEnrolmentComponentExtension

Added properties:

  • exclude_from_nzqa (boolean)

NewZealandIntakeComponentExtension

Added properties:

  • exclude_from_nzqa (boolean)

NewZealandProgrammeExtension

Added properties:

  • newZealandProgrammeExtensionNewZealandFieldOfStudyAssociations (NewZealandProgrammeExtensionNewZealandFieldOfStudyAssociation[])

Version 3.31

Modified Resources

Component

Added properties:

  • expiry_duration (integer|string)
  • expiry_duration_unit (string)

Enrolment

Added properties:

  • expiry_date (date-time)

EnrolmentComponent

Added properties:

  • expiry_date (date-time)

NewZealandIntakeExtension

Added properties:

  • forecasted_enrolments (integer)

Programme

Added properties:

  • expiry_duration (integer|string)
  • expiry_duration_unit (string)

Student

Added properties:

  • phone_mobile_validated_at (date-time)
  • phone_home_validated_at (date-time)
  • phone_work_validated_at (date-time)

User

Added properties:

  • email_signature (string)

Version 3.30

New Endpoints

  • /api/custom_fields
  • /api/custom_fields/{id}
  • /api/custom_field_options
  • /api/custom_field_options/{id}
  • /api/custom_field_values
  • /api/custom_field_values/{id}
  • /api/visa_subtypes
  • /api/visa_subtypes/code/{code}
  • /api/visa_subtypes/{id}

New Resources

CustomField

Properties:

  • id (integer)
  • label (string)
  • api_name (string)
  • custom_field_type (CustomFieldType)
  • description (string)
  • default_value (string[])
  • mandatory (boolean)
  • validation_regex (string)
  • max_length (integer)
  • sort_order (integer|string)
  • system_default (boolean)
  • customFieldOptions (string[])
  • created_at (date-time)
  • updated_at (date-time)

CustomFieldOption

Properties:

  • id (integer)
  • custom_field (string)
  • code (string)
  • name (string)
  • active (boolean)
  • system_default (boolean)
  • value (string)
  • sort_order (integer)
  • created_at (date-time)
  • updated_at (date-time)

CustomFieldType

Properties:

  • id (integer)
  • code (string)
  • created_at (date-time)
  • updated_at (date-time)

VisaSubtype

Properties:

  • id (integer)
  • visa_type (VisaType)
  • code (string)
  • name (string)
  • label (string)
  • active (boolean)
  • default_value (boolean)
  • system_default (boolean)
  • created_at (date-time)
  • updated_at (date-time)

Modified Resources

Campus

Added properties:

  • customFieldValues (string[])

Component

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

Contact

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

CustomFieldValue

Added properties:

  • id (integer)
  • custom_field (string)
  • student (string)
  • enrolment (string)
  • enrolment_component (string)
  • intake (string)
  • intake_component (string)
  • programme (string)
  • component (string)
  • campus (string)
  • contact (string)
  • organisation (string)
  • class (string)
  • sysuser (string)
  • application (Application)
  • placement (string)
  • selected_value (string[])
  • created_at (date-time)
  • updated_at (date-time)

Enrolment

Added properties:

  • customFieldValues (string[])

EnrolmentComponent

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

GradingScheme

Added properties:

  • past_days_warning (integer)

Removed properties:

  • programmeComponents
  • intakeComponents

Intake

Added properties:

  • customFieldValues (string[])

IntakeComponent

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

NewZealandEnrolmentComponentExtension

Added properties:

  • exclude_from_sdr (boolean)

Organisation

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

Placement

Added properties:

  • customFieldValues (string[])

Programme

Changed properties:

  • customFieldValues: CustomFieldValue[] → string[]

Student

Added properties:

  • customFieldValues (string[])

SysClass

Added properties:

  • customFieldValues (string[])

User

Added properties:

  • customFieldValues (string[])

Visa

Added properties:

  • visa_subtype (string)
  • valid_to (date-time)

Related Articles

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

Features/Improvements Enhanced Student Enrolment Flow The enrolment process has been streamlined with improved automations and additional fields. Users now have even greater control when enrolling students, with new options and field configurations available to customise the enrolment workflow according to institutional needs. Form Submission PDF Documents Form submissions now automatically attach the generated submission PDF …

3.10.0 Release Notes

Features/Improvements Stripe Integration Integration with Stripe payment processing is now available for handling online payments. Intake Component Propagation When mapping components to an intake, you now have the option to: If propagating to enrolments: NZQA Enhancements Single-Student ROL Generation Added “Generate ROL Request File” button directly in the Student’s “Achieved Unit Standards” section, allowing administrators …