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.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:
programmeComponentsintakeComponents
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)
Version 3.29
New Endpoints
/api/organisation_sysusers/api/organisation_sysusers/{id}
New Resources
OrganisationSysuser
Properties:
id(integer)organisation(string)sysuser(string)valid_from(date-time)valid_to(date-time)created_at(date-time)updated_at(date-time)
Modified Resources
AccommodationCriteriaType
Added properties:
created_at(date-time)updated_at(date-time)
AccommodationProvider
Added properties:
city(string)created_at(date-time)updated_at(date-time)
AccommodationProviderCriteria
Added properties:
created_at(date-time)updated_at(date-time)
AccommodationProviderStatus
Added properties:
created_at(date-time)updated_at(date-time)
Address
Added properties:
created_at(date-time)updated_at(date-time)
AddressType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaAccountExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaAnzsco
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaAnzsic
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaCampusExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaCitizenshipStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaClientIndustryOfEmployment
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaClientOccupation
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaCommencingProgram
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaComponentExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaContractSchedulePaymentOutcomeRule
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaContractSchedulePaymentType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaCountry
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaCurrentSchoolLevel
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaDeliveryModeAvetmiss
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaDisabilityFlag
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaDisabilityType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEligibilityExemption
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEmployerContribution
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEmployerType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEnrolmentCategory
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEnrolmentComponentExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEnrolmentExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEnrolmentExtensionAustraliaDeliveryModeAvetmissAssociation
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaEnrolmentLiabilityType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaFeeExemptionConcessionType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaFinanceCode
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaFullTime
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaFundingSourceNational
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaFundingSourceState
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaHighestSchoolLevelCompleted
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaIndigenousStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaIntakeExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaLabourForceStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaLanguage
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaOrganisationExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaPriorEducationalAchievement
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaPriorEducationalAchievementFlag
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaPriorEducationalAchievementRecognition
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaProgramFieldOfEducation
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaProgramLevelOfEducation
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaProgramRecognition
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaProgramStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaProgrammeExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaResidencyStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaSchoolType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaSpecificFunding
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaSpecificFundingIdentifierState
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaState
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaStateFundingFormat
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaStudentExtension
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaStudyReason
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaSubjectFieldOfEducation
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaSurveyContactStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaTrainingContractStatus
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaTrainingType
Added properties:
created_at(date-time)updated_at(date-time)
AustraliaVetStudentLoan
Added properties:
created_at(date-time)updated_at(date-time)
BookingStatus
Added properties:
created_at(date-time)updated_at(date-time)
Campus
Added properties:
created_at(date-time)updated_at(date-time)
CampusStatus
Added properties:
created_at(date-time)updated_at(date-time)
Citizenship
Added properties:
created_at(date-time)updated_at(date-time)
ClassSysuserRole
Added properties:
created_at(date-time)updated_at(date-time)
Comment
Added properties:
created_at(date-time)updated_at(date-time)
ComponentType
Added properties:
created_at(date-time)updated_at(date-time)
Contact
Added properties:
created_at(date-time)updated_at(date-time)
ContactStatus
Added properties:
created_at(date-time)updated_at(date-time)
ContactType
Added properties:
created_at(date-time)updated_at(date-time)
Country
Added properties:
created_at(date-time)updated_at(date-time)
Currency
Added properties:
created_at(date-time)updated_at(date-time)
CurriculumStatus
Added properties:
created_at(date-time)updated_at(date-time)
Disability
Added properties:
created_at(date-time)updated_at(date-time)
Document
Added properties:
created_at(date-time)updated_at(date-time)
DocumentType
Added properties:
created_at(date-time)updated_at(date-time)
DurationUnit
Added properties:
created_at(date-time)updated_at(date-time)
EmploymentType
Added properties:
created_at(date-time)updated_at(date-time)
Enrolment
Added properties:
created_at(date-time)updated_at(date-time)attendance_start_date(date-time)
EnrolmentCompletionCode
Added properties:
created_at(date-time)updated_at(date-time)
EnrolmentComponent
Added properties:
created_at(date-time)updated_at(date-time)
EnrolmentComponentGrade
Added properties:
created_at(date-time)updated_at(date-time)
EnrolmentPayerType
Added properties:
created_at(date-time)updated_at(date-time)
EnrolmentStatus
Added properties:
created_at(date-time)updated_at(date-time)
Event
Added properties:
accommodation_booking(AccommodationBooking)created_at(date-time)updated_at(date-time)
EventPriority
Added properties:
created_at(date-time)updated_at(date-time)
EventType
Added properties:
created_at(date-time)updated_at(date-time)
FeeCategory
Added properties:
created_at(date-time)updated_at(date-time)
FeeType
Added properties:
created_at(date-time)updated_at(date-time)
FormSubmissionStatus
Added properties:
created_at(date-time)updated_at(date-time)
Gender
Added properties:
created_at(date-time)updated_at(date-time)
GradingScheme
Added properties:
created_at(date-time)updated_at(date-time)
GradingSchemeGrade
Added properties:
range_from(integer|string)range_to(integer|string)created_at(date-time)updated_at(date-time)
Removed properties:
percent_frompercent_to
GridReport
Added properties:
created_at(date-time)updated_at(date-time)
IndustryType
Added properties:
created_at(date-time)updated_at(date-time)
Insurance
Added properties:
created_at(date-time)updated_at(date-time)
InsuranceType
Added properties:
created_at(date-time)updated_at(date-time)
Intake
Added properties:
created_at(date-time)updated_at(date-time)
Removed properties:
form
IntakeComponent
Added properties:
created_at(date-time)updated_at(date-time)
IntakeFee
Added properties:
created_at(date-time)updated_at(date-time)
IntakeStatus
Added properties:
created_at(date-time)updated_at(date-time)
IntakeSysuser
Added properties:
created_at(date-time)updated_at(date-time)
IntakeSysuserRole
Added properties:
created_at(date-time)updated_at(date-time)
InvoicePayerType
Added properties:
created_at(date-time)updated_at(date-time)
InvoiceStatus
Added properties:
created_at(date-time)updated_at(date-time)
JobPosition
Added properties:
created_at(date-time)updated_at(date-time)
LearningStyle
Added properties:
created_at(date-time)updated_at(date-time)
MarketingSource
Added properties:
created_at(date-time)updated_at(date-time)
MedicalCondition
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandAccountExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandAttendanceMode
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandAustralianResidentialStatus
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandCampusExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandComponentExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandConsortium
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandCourseClassification
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandCourseExemptIndicator
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandCoursePbrfIndicator
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandDisability
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandDisabilityIndicator
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandDisabilityServicesAccessedIndicator
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandDisabilityStatus
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandDisabilitySupport
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEnrolmentComponentExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEnrolmentExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEnrolmentExtensionNewZealandIteSubjectAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEnrolmentExtensionNewZealandReturnTypeAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEnrolmentType
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandEthnicity
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandFieldOfStudy
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandFundingCategory
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandFundingSource
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIndustryCode
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIntakeComponentExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIntakeExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandInternationalFeeCategory
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIteSector
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIteSubject
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandIwi
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandModeOfDelivery
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandNationalQualificationProgramme
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandNzsced
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandOccupationCode
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandPreviousActivity
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandProgrammeExtension
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandProgrammeLevel
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandProgrammeType
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandQualification
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandQualificationAwardCategoryCode
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandResidencyStatus
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandResidentialStatus
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandReturnType
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandSdrType
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandSecondarySchool
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandSecondarySchoolQualification
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudentExtension
Added properties:
lnaat_tec_learner_id(string)created_at(date-time)updated_at(date-time)
NewZealandStudentExtensionNewZealandDisabilitySupportAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudentExtensionNewZealandEthnicityAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudentExtensionNewZealandIwiAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudentExtensionNewZealandResidencyStatusAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudentExtensionNewZealandUnitStandardAssociation
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandStudyType
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandUnitStandard
Added properties:
created_at(date-time)updated_at(date-time)
NewZealandWorkBasedTrainingType
Added properties:
created_at(date-time)updated_at(date-time)
Organisation
Added properties:
organisationSysusers(string[])created_at(date-time)updated_at(date-time)
OrganisationContact
Added properties:
is_primary(boolean)created_at(date-time)updated_at(date-time)
OrganisationContactRelationship
Added properties:
created_at(date-time)updated_at(date-time)
OrganisationJobPosition
Added properties:
created_at(date-time)updated_at(date-time)
OrganisationStatus
Added properties:
created_at(date-time)updated_at(date-time)
OrganisationType
Added properties:
created_at(date-time)updated_at(date-time)
Passport
Added properties:
created_at(date-time)updated_at(date-time)
PaymentType
Added properties:
created_at(date-time)updated_at(date-time)
PhonePrefix
Added properties:
created_at(date-time)updated_at(date-time)
Placement
Added properties:
created_at(date-time)updated_at(date-time)
PlacementStatus
Added properties:
created_at(date-time)updated_at(date-time)
PlacementType
Added properties:
created_at(date-time)updated_at(date-time)
Programme
Added properties:
created_at(date-time)updated_at(date-time)
ProgrammeComponent
Added properties:
created_at(date-time)updated_at(date-time)
ProgrammeProgress
Added properties:
created_at(date-time)updated_at(date-time)
Pronoun
Added properties:
created_at(date-time)updated_at(date-time)
Region
Added properties:
created_at(date-time)updated_at(date-time)
Religion
Added properties:
created_at(date-time)updated_at(date-time)
ReportBuilderReport
Added properties:
created_at(date-time)updated_at(date-time)
ResourceCategory
Added properties:
created_at(date-time)updated_at(date-time)
RoomBlockCategory
Added properties:
created_at(date-time)updated_at(date-time)
RoomType
Added properties:
created_at(date-time)updated_at(date-time)
Student
Added properties:
created_at(date-time)updated_at(date-time)
StudentContactAssociation
Added properties:
created_at(date-time)updated_at(date-time)
StudentContactAssociationType
Added properties:
created_at(date-time)updated_at(date-time)
StudentOrganisationAssociation
Added properties:
created_at(date-time)updated_at(date-time)
StudentOrganisationAssociationType
Added properties:
created_at(date-time)updated_at(date-time)
StudentStatus
Added properties:
created_at(date-time)updated_at(date-time)
StudentValidationType
Added properties:
created_at(date-time)updated_at(date-time)
SysClass
Added properties:
created_at(date-time)updated_at(date-time)
SysClassSysUser
Added properties:
created_at(date-time)updated_at(date-time)
SysuserStatus
Added properties:
created_at(date-time)updated_at(date-time)
Tag
Added properties:
created_at(date-time)updated_at(date-time)
TagAssociation
Added properties:
created_at(date-time)updated_at(date-time)
TimeSheetEntry
Added properties:
created_at(date-time)updated_at(date-time)
Title
Added properties:
created_at(date-time)updated_at(date-time)
User
Added properties:
created_at(date-time)updated_at(date-time)
Validation
Added properties:
created_at(date-time)updated_at(date-time)
Visa
Added properties:
created_at(date-time)updated_at(date-time)
VisaStatus
Added properties:
created_at(date-time)updated_at(date-time)
VisaType
Added properties:
created_at(date-time)updated_at(date-time)
WithdrawalReason
Added properties:
created_at(date-time)updated_at(date-time)
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:
preferredNamephoneMobilephoneHomephoneWorkemailPrimaryemailSecondaryemailSchoolxeroGuid
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 → ?intduration: ?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 → ?intplaces_maximum: ?string → ?intplaces_forecast: ?string → ?intplaces_budget: ?string → ?intcloud_assess_intake_id: ?string → ?int
NewZealandEnrolmentExtension
Removed properties:
work_based_training_syncedpublic_trust_tuition_start_datepublic_trust_accommodation_start_datepublic_trust_living_expenses_start_datepublic_trust_bailment_start_datepublic_trust_health_travel_start_datepublic_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.
