Overview

Each example for creating a record shows the JSON document to send as the HTTP body. Any text in highlighted in green (at least) should be reviewed and edited per HTTP call to create a record.

...

API Entity Record Types	Brief Description
Program	Program : a Program/Course of Study definition
ProgramUnitConstraint	Program-Unit Constraint : rule relating Programs and Units Unit
ScheduledUnit	Scheduled Unit : a Unit of Study delivered, by method and period
ScheduledFee	Scheduled Fee : define a fee per ScheduledUnit/Program/FeeType
ScheduledUnitFee ScheduledUnitFee	Scheduled Unit Fee : API entity only, wraps the two types above
UnitAssessment	Unit Assessment : An Assessment task assigned to a Unit of Study
UnitCompetency	Unit Competency : A Competency type of Unit Assessment
Competency	Competency : A nationally defined Unit of Competency
CodeItem	Code Item (multiple types) : used for various look-up attributes
StatusItem	Status Item (multiple types) : used for status look-up attributes

Create an entity record (HTTP POST method) (template URL for each relevant API entity type)

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/Program	Program/Course of Study
POST https://{host}.edu.net.au/api /rest/v1/Unit	Unit of Study
POST https://{host}.edu.net.au/api /rest/v1/ProgramUnitConstraint	Program-Unit Relationship
POST https://{host}.edu.net.au/api /rest/v1/ScheduledUnit	Scheduled Unit of Study
POST https://{host}.edu.net.au /api/rest/v1/ScheduledUnitFee	Scheduled Unit Fee
POST https://{host}.edu.net.au/api/rest/v1/UnitAssessment	Unit of Study Assessment
POST https://{host}.edu.net.au/api/rest/v1/UnitCompetency	Unit of Study Competency
POST https://{host}.edu.net.au/api/rest/v1/Competency	Unit of Competency
POST https://{host}.edu.net.au/api/rest/v1/CodeItem	Code Item
POST https://{host}.edu.net.au/api/rest/v1/StatusItem	Status Item

...

Code	Field
GET https://{host}.edu.net.au/api/rest/v1/Program?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Program/Course of Study
GET https://{host}.edu.net.au/api/rest/v1/Unit?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Unit of Study
GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Program-Unit Relationship
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Scheduled Unit of Study
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Scheduled Unit Fee
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Unit of Study Assessment
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Unit of Study Competency
GET https://{host}.edu.net.au/api/rest/v1/Competency ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Unit of Competency
GET https://{host}.edu.net.au/api/rest/v1/CodeItem?codeTypeId={codeTypeId} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Code Item
GET https://{host}.edu.net.au/api/rest/v1/StatusItem? statusTypeId={ statusTypeId} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value}	Status Item

...

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/Unit
{
"eduUnitId": "ICX1234",	Unit Code (Primary key, fixed)
"eduOtherUnitId": "ICX1234",	Unit Code (required,updateable)
"eduProviderOtherUnitId": "ICX1234",	External Unit Code (optional,updateable)
"unitName": "Example Unit Name",	Unit Name
"unitCategory": "2",	Unit Category (Code=UNIT_CATEGORY)
"unitStatusId": "UNIT_ACTIVE",	Status (ACTIVE/INACTIVE/ARCHIVED)
"providerPartyId": "10000",	Provider (DEFAULT=10000)
"creditStatement": "",	Credit Statement (point/hours, optional)
"pgradEftsuLoad": "0.0",	Study Load (EFTSL) for Postgrad (NA)
"ugradEftsuLoad": "0.0625",	Study Load (EFTSL) for VET/Undergrad
"description": "Example Unit description ",	Unit Description (optional)
"requirements": "Example Unit requirements ",	Unit Description (optional)
"destDiscipline": "80300",	HEIMS Discipline
"destWorkExperienceIndicator": "0",	HEIMS Work Experience Indicator
"method": "ONLINE",	Delivery Mode
"avet018": "20",	Delivery Mode Identifier
"avet040": "60",	Nominal Hours
"avet058": "60",	Scheduled Hours
"avet078": "N"	VET in Schools program (Y/N)
}

...

Update an existing Unit entity record

Code	Field
PUT https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId}	{eduUnitId} to be replaced by Unit Code (Primary key, fixed)
{
"eduProviderOtherUnitId": "ICX1234",	External Unit Code
"unitName": "Example Unit Name",	Unit Name
"unitCategory": "2",	Unit Category
"unitStatusId": "UNIT_ACTIVE",	Status
"pgradEftsuLoad": "0.0",	Study Load (EFTSL) for Postgrad
"ugradEftsuLoad": "0.0625",	Study Load (EFTSL) for VET/Undergrad
"description": "Example Unit description",	Unit Description (optional)
"requirements": "Example Unit requirements",	Unit Description (optional)
"destDiscipline": "80300",	HEIMS Discipline
"destWorkExperienceIndicator": "0",	HEIMS Work Experience Indicator
"method": "ONLINE",	Delivery Mode
"avet018": "20",	Delivery Mode Identifier
"avet040": "60",	Nominal Hours
"avet058": "60",	Scheduled Hours
"avet078": "N"	VET in Schools program (Y/N)
}

Code Block

language	xml

PUT https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId}
{
"eduProviderOtherUnitId": "ICX1234",
"unitName": "Example Unit Name",  
"unitCategory": "2", 
"unitStatusId": "UNIT_ACTIVE", 
"pgradEftsuLoad": "0.0",
"ugradEftsuLoad": "0.0625",  
"description": "Example Unit description ",   
"requirements": "Example Unit requirements ",  
"destDiscipline": "80300",
"destWorkExperienceIndicator": "0",
"method": "ONLINE",
"avet018": "20",
"avet040": "60",  
"avet058": "60",
"avet078": "N" 
}

...

Create a new ScheduledUnitFee entity record (new API entity to simplify unit fee management)

ScheduledUnit and ScheduledFee wrapper

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee
{
"eduUnitId": "ICX1234",	Unit Code (FK to Unit.eduUnitId)
"eduOtherUnitId": "ICX1234",	Unit Code (required, updateable)
"eduProviderOtherUnitId": "ICX1234",	Unit Code (optional, updateable)
"unitName": "Example Unit Name",	Unit Name (optional)
"unitStatusId": "UNIT_ACTIVE",	Status (ACTIVE/INACTIVE)
"providerPartyId": "10000",	Provider (DEFAULT=10000)
"startDate" : "20150101T00:00:00",	Start Date (YYYYMMDD)
"endDate" : "20151231T00:00:00",	End Date (YYYYMMDD)
"fee": "1000.00",	Unit Fee Amount (AUD)
"feeTypeId": "STANDARD_FEE",	Fee Type (Code=FEE_TYPE)
"description": "Standard Fee",	Fee Description (optional)
"modeOfDelivery": "ONLINE",	Mode of Delivery (ONLINE)
"flexibleLearning": "Y",	Flexible Learning (Y/N)
"maximumParticipants": "10000"	Maximum allowed enrolments
}

...

Update an existing ScheduledUnitFee entity record (new API entity to simplify unit fee management)

ScheduledUnit and ScheduledFee wrapper

Code	Field
PUT https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId}
{
"eduProviderOtherUnitId": "ICX1234",	Unit Code (optional)
"unitName": "Example Unit Name",	Unit Name (optional)
"unitStatusId": "UNIT_ACTIVE",	Status (ACTIVE/INACTIVE)
"providerPartyId": "10000",	Provider (DEFAULT=10000)
"startDate" : "20150101T00:00:00",	Start Date (YYYYMMDD)
"endDate" : "20151231T00:00:00",	End Date (YYYYMMDD)
"fee": "1000.00",	Unit Fee Amount (AUD)
"feeTypeId": "STANDARD_FEE",	Fee Type (Code=FEE_TYPE)
"description": "Standard Fee",	Fee Description (optional)
"modeOfDelivery": "ONLINE",	Mode of Delivery (ONLINE)
"flexibleLearning": "Y",	Flexible Learning (Y/N)
"maximumParticipants": "10000"	Maximum allowed enrolments
}

...

Create a new UnitCompetency entity record (new API entity to simplify unit competencies)

UnitAssessment wrapper for COMPETENCY_UNIT

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/UnitCompetency
{
"eduUnitId": "ICX1234",	Unit Code (FK to Unit.eduUnitId)
"competencyId": "ABC10203",	Code of the Assessment
"competencyName": "Example Competency Name",	Name of the Assessment
"statusId": "ASSESSMENT_ACTIVE",	Status (ACTIVE/INACTIVE)
"description": "Example Competency Description",	Description of the Assessment
"vetScheduledHours": "60",	Scheduled Hours for Assessment
"vetDeliveryMode": "20",	Mode of Delivery (AVETMISS)
"vetInSchoolsFlag": "N"	VET in Schools flag (Y/N)
}

...

Update existing UnitCompetency entity record (new API entity to simplify unit competencies

UnitAssessment wrapper for COMPETENCY_UNIT

Code	Field
PUT https://{host}.edu.net.au/api/rest/v1/UnitCompetency/{assessmentId}
{
"competencyId": "ABC10203",	Code of the Assessment
"competencyName": "Example Competency Name",	Name of the Assessment
"statusId": "ASSESSMENT_ACTIVE",	Status (ACTIVE/INACTIVE)
"description": "Example Competency Description",	Description of the Assessment
"vetScheduledHours": "60",	Scheduled Hours for Assessment
"vetDeliveryMode": "20",	Mode of Delivery (AVETMISS)
"vetInSchoolsFlag": "N"	VET in Schools flag (Y/N)
}

...

Create a new Program entity record

Single Diploma

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/Program
{
"eduProgramId" : "DipBus",	Course Code (PK,fixed)
"programName" : Diploma of Business",	Course Name
"programStatusId" : "PROGRAM_ACTIVE",	Status (ACTIVE/INACTIVE/ARCHIVED)
"programType" : "COURSEWORK",	Course Type
"programLevel" : "VET",	Course Level
"programDuration" : "52.0",	Duration (weeks)
"programLevelInt" : "5",	Program Level No (Dip=5, AdvDip=6)
"providerPartyId" : "33594",	Provider (SGA=33594,ACA=39114)
"studyArea" : "BUS",	Course Study Area (optional)
"standardCourseFee" : "12600.0",	Course Fee (full-course total unit fees)
"standardUnitFee" : "1575.0"	Standard Unit Fee
"destCourseCode" : "BSB50207",	HEIMS Course Code
"destE533" : " BSB50207",	HEIMS Course of Study Code
"destCourseLoad" : "0.75"	HEIMS Course Load
"destCourseType" : "21",	HEIMS Course Type
"destEduField" : "080300",	HEIMS Education Field
"destSpecialCourseCode" : "00",	HEIMS Special Course Code
"destCombinedCourseCode" : "0",	HEIMS Combined Course Code
"destLoanFeePostgrad" : "0.0"	HEIMS Postgraduate Loan Fee (%)
"destLoanFeeUndergrad" : "20.0",	HEIMS VET/Undergraduate Loan Fee (%)
"avet052" : "803",	Course Field of Education Identifier
"avet053" : "BSB50207",	Course Identifier
"avet054" : "421",	Course Level of Education Identifier
"avet056" : "11",	Course Recognition Identifier
"avet005" : "511112",	ANZCO Identifier
"avet040" : "480",	Nominal Hours
"avet077" : "Y",	VET Flag
"accredited" : "YES",	Accreditation Flag (Y/N)
"accreditationDate" : "20150101T00:00:00",	Accreditation Date (YYYYMMDD)
"accreditationDateDue" : "20161231T00:00:00",	Accreditation Date Due (YYYYMMDD)
"allowInternationalStudent" : "NO"	Allow International Students (YES/NO)
"allowOnlineApplication" : "YES",	Allow Online Application (YES/NO)
"aqfRegistered" : "Y",	AQF Registered (Y/N)
"ecafApproved" : "Y",	ECAF Approved (Y/N
"fundingType" : "'UPFRONT_FEES','FEE_HELP'",	Funding Type (multiple select)
"unitGradeType" : "UNIT_GRADE",	Unit Grade Type
"assessmentGradeType" : "ASSESSMENT_GRADE",	Assessment Grade Type
"requirements" : "To enrol in this course, you will need to speak and write in English to at least Year 12 level. \\\nYou will also need to have one of the following:\\\n Australian Year 12 or equivalent; OR\\\n a Certificate IV; OR\\\n be aged over 20 and have demonstrated skills acquired through work experience; OR\\\n within the Admissions Interview be able to demonstrate that you have the skills and capability to succeed in the course."	Entry Requirements (optional description)
}

...

Code Block

language	xml

POST https://{host}.edu.net.au/api/rest/v1/Program  
{    
"eduProgramId" : "DipBus",  
"programName" : Diploma of Business",  
"programStatusId" : "PROGRAM_ACTIVE",
"programType" : "COURSEWORK", 
"programLevel" : "VET", 
"programDuration" : "52.0",  
"programLevelInt" : "5",    
"providerPartyId" : "33594",  
"studyArea" : "BUS",  
"standardCourseFee" : "12600.0",  
"standardUnitFee" : "1575.0",  
"destCourseCode" : "BSB50207",
"destE533" : " BSB50207", 
"destCourseLoad" : "0.75"
"destCourseType" : "21",
"destEduField" : "080300",
"destSpecialCourseCode" : "00",
"destCombinedCourseCode" : "0",
"destLoanFeePostgrad" : "0.0", 
"destLoanFeeUndergrad" : "20.0", 
"avet052" : "803",   
"avet053" : "BSB50207", 
"avet054" : "421",
"avet056" : "11", 
"avet005" : "511112",
"avet040" : "480",
"avet077" : "Y", 
"accredited" : "YES", 
"accreditationDate" : "20150101T00:00:00",
"accreditationDateDue" : "20161231T00:00:00",
"allowInternationalStudent" : "NO",
"allowOnlineApplication" : "YES",
"aqfRegistered" : "Y",
"ecafApproved" : "Y",  
"fundingType" : "'UPFRONT_FEES','FEE_HELP'",
"unitGradeType" : "UNIT_GRADE",  
"assessmentGradeType" : "ASSESSMENT_GRADE",  
"requirements" : "To enrol in this course, you will need to speak and write in English to at least Year 12 level. \\\nYou will also need to have one of the following:\\\n    Australian Year 12 or equivalent; OR\\\n    a Certificate IV; OR\\\n    be aged over 20 and have demonstrated skills acquired through work experience; OR\\\n    within the Admissions Interview be able to demonstrate that you have the skills and capability to succeed in the course." 
}

Create a new ProgramUnitContraint entity record

(example for single diploma course outline core unit) Single Diploma CORE UNIT

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint
{
"constraintTypeId": "CORE_UNIT",	Core Unit Rule
"eduProgramId": "DipBus",	Course Code
"eduUnitId": "ICX1234",	Core Unit Code
"displayCode": "A1",	Stage (A1/B1/C1/D1/etc)
"description": "Business Core Unit"	Rule Description (optional)
}

Code Block

POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint  
{   
"constraintTypeId": "CORE_UNIT",
"eduProgramId": "DipBus",
"eduUnitId": "ICX1234",
"displayCode": "A1",
"description": "Business Core Unit" 
}

Examples for Double Diploma Program entity and related entities

Each example for creating a record shows the JSON document to send as the HTTP body. Any text in highlighted in green (at least) should be reviewed and edited per HTTP call to create a record.

Create a new Program entity record - Double Diploma

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/Program
{
"eduProgramId" : "DipBusBeTh",	Course Code (PK,fixed)
"programName" : "Double Diploma of Business and Beauty Therapy",	Course Name
"programStatusId" : "PROGRAM_ACTIVE",	Status (ACTIVE/INACTIVE/ARCHIVED)
"programType" : "COURSEWORK",	Course Type
"programLevel" : "VET",	Course Level
"programDuration" : "52.0",	Duration (weeks)
"programLevelInt" : "5",	Program Level No (Dip=5, AdvDip=6)
"providerPartyId" : "33594",	Provider (SGA=33594,ACA=39114)
"studyArea" : "BUS",	Course Study Area (optional)
"standardCourseFee" : "12600.0",	Course Fee (full-course total unit fees)
"standardUnitFee" : "1575.0",	Standard Unit Fee
"destCourseLoad" : "0.75"	HEIMS Course Load
"destCourseType" : "21",	HEIMS Course Type
"destEduField" : "080300",	HEIMS Education Field
"destLoanFeePostgrad" : "0.0",	HEIMS Postgraduate Loan Fee (%)
"destLoanFeeUndergrad" : "20.0",	HEIMS VET/Undergraduate Loan Fee (%)
"accredited" : "YES",	Accreditation Flag (Y/N)
"accreditationDate" : "20150101T00:00:00",	Accreditation Date (YYYYMMDD)
"accreditationDateDue" : "20161231T00:00:00",	Accreditation Date Due (YYYYMMDD)
"allowInternationalStudent" : "NO",	Allow International Students (YES/NO)
"allowOnlineApplication" : "YES",	Allow Online Application (YES/NO)
"aqfRegistered" : "N",	AQF Registered (Y/N)
"ecafApproved" : "Y",	ECAF Approved (Y/N)
"fundingType" : "'UPFRONT_FEES','FEE_HELP'",	Funding Type (multiple select)
"unitGradeType" : "UNIT_GRADE",	Unit Grade Type
"assessmentGradeType" : "ASSESSMENT_GRADE",	Assessment Grade Type
"requirements" : "To enrol in this course, you will need to speak and write in English to at least Year 12 level. \\\nYou will also need to have one of the following:\\\n Australian Year 12 or equivalent; OR\\\n a Certificate IV; OR\\\n be aged over 20 and have demonstrated skills acquired through work experience; OR\\\n within the Admissions Interview be able to demonstrate that you have the skills and capability to succeed in the course."	Entry Requirements (optional description)
}

Code Block

POST https://{host}.edu.net.au/api/rest/v1/Program  
{
"eduProgramId" : "DipBusBeTh",
"programName" : "Double Diploma of Business and Beauty Therapy",
"programStatusId" : "PROGRAM_ACTIVE",
"programType" : "COURSEWORK",
"programLevel" : "VET",
"programDuration" : "52.0",
"programLevelInt" : "5",
"providerPartyId" : "33594",
"studyArea" : "BUS",
"standardCourseFee" : "12600.0",
"standardUnitFee" : "1575.0",
"destCourseLoad" : "0.75"
"destCourseType" : "21",
"destEduField" : "080300",
"destLoanFeePostgrad" : "0.0",
"destLoanFeeUndergrad" : "20.0",
"accredited" : "YES",
"accreditationDate" : "20150101T00:00:00", 
"accreditationDateDue" : "20161231T00:00:00",
"allowInternationalStudent" : "NO",
"allowOnlineApplication" : "YES",
"aqfRegistered" : "N",
"ecafApproved" : "Y",
"fundingType" : "'UPFRONT_FEES','FEE_HELP'",
"unitGradeType" : "UNIT_GRADE",
"assessmentGradeType" : "ASSESSMENT_GRADE",
"requirements" : "To enrol in this course, you will need to speak and write in English to at least Year 12 level. \\\nYou will also need to have one of the following:\\\n    Australian Year 12 or equivalent; OR\\\n    a Certificate IV; OR\\\n    be aged over 20 and have demonstrated skills acquired through work experience; OR\\\n    within the Admissions Interview be able to demonstrate that you have the skills and capability to succeed in the course."
}

Create a new ProgramUnitContraint entity record

(only valid for double diploma course outline to define a child single diploma course under the double diploma) Double Diploma COMPONENT PROGRAM

Code	Field name
POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint
{
"constraintTypeId": "COMPONENT_PROGRAM",	Parent-Child Course Rule
"eduProgramId": "DipBusBeTh",	Parent Course Code
"constraintProgramId": "DipBus",	Child Course Code
"description": "Business and Beauty Therapy Component Program"	Rule Description (optional)
}

Code Block

POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint  
{
"constraintTypeId": "COMPONENT_PROGRAM",
"eduProgramId": "DipBusBeTh",
"constraintProgramId": "DipBus",
"description": "Business and Beauty Therapy Component Program"
}

Create a new ProgramUnitContraint entity record

(only valid for double diploma course outline to define an exemption unit equivalent to a matching core unit)

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint
{
"constraintTypeId": "SUBSTITUTE_UNIT",	Equivalent Child Unit Rule
"eduProgramId": "DipBusBeTh",	Parent Course Code
"constraintProgramId": "DipBeTh",	Child Course Code
"eduUnitId": "ICB1233",	Exempted Child Unit Code
"constraintEduUnitId": "ICX1234",	Equivalent Core Unit Code
"displayCode": "",	Stage (blank for no stage)
"description": "Business and Beauty Therapy Equivalent Unit"	Rule Description (optional)
}

Code Block

POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint  
{    
"constraintTypeId": "SUBSTITUTE_UNIT", 
"eduProgramId": "DipBusBeTh",
"constraintProgramId": "DipBeTh",
"eduUnitId": "ICB1233",
"constraintEduUnitId": "ICX1234",
"displayCode": "",
"description": "Business and Beauty Therapy Equivalent Unit"
}

Create a new ProgramUnitContraint entity record

(example for double diploma course outline core unit)

Code	Field
POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint
{
"constraintTypeId": "CORE_UNIT",	Core Child Unit Rule
"eduProgramId": "DipBusBeTh",	Parent Course Code
"constraintProgramId": "DipBus",	Child Course Code
"eduUnitId": "ICX1234",	Core Unit Code
"displayCode": "A1",	Stage (A1/B1/C1/D1/etc
"description": "Business and Beauty Therapy Core Unit"	Rule Description (optional)
}

Code Block

POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint  
{   
"constraintTypeId": "CORE_UNIT", 
"eduProgramId": "DipBusBeTh",
"constraintProgramId": "DipBus",
"eduUnitId": "ICX1234",
"displayCode": "A1",
"description": "Business and Beauty Therapy Core Unit"
}

Examples for retrieving listings of entity records

Each example for retrieving a list of entity records using the HTTP GET method with URL parameters to specify search criteria. Any text in highlighted in green (at least) should be reviewed and edited per HTTP call to retrieve a list of records.

Find entity records matching criteria (HTTP GET method)

(template URL for each relevant API entity type)

Code	Field
GET https://{host}.edu.net.au/api/rest/v1/Program?{fieldName}={value}	Program
GET https://{host}.edu.net.au/api/rest/v1/Unit?{fieldName}={value}	Unit
GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint?{fieldName}={value}	Program Unit Contraint
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit?{fieldName}={value}	Scheduled Unit
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee?{fieldName}={value}	Scheduled unit Fee
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment?{fieldName}={value}	Unit Assessment
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency?{fieldName}={value}	Unit Competency
GET https://{host}.edu.net.au/api/rest/v1/Competency?{fieldName}={value}	Comptetency

Code Block

GET https://{host}.edu.net.au/api/rest/v1/Program?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/Unit?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment ?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency ?{fieldName}={value} 
GET https://{host}.edu.net.au/api/rest/v1/Competency ?{fieldName}={value}

Find Program entity records

Replace {value} with text, join criteria with “&”

Code	Field
GET https://{host}.edu.net.au/api/rest/v1/Program
eduProgramId={value}	Program Code (full/partial)
programName ={value}	Program Name (full/partial)
programStatusId ={value}	Program Status (status id)
keywords ={value}	Keywords (partial match)

Example URL query Criteria	Field
?programStatusId=PROGRAM_ACTIVE	All ACTIVE Programs
?programStatusId=PROGRAM_INACTIVE	All INACTIVE Programs
?programStatusId=PROGRAM_ACTIVE&programName=Diploma	ACTIVE Diploma Programs

Code Block
GET https://{host}.edu.net.au/api/rest/v1/Program eduProgramId={value} programName ={value} programStatusId ={value} keywords ={value}

Find ProgramUnitConstraint entity records

Replace {value} with text, join criteria with “&”

Code	Field
GET https://{host}.edu.net.au/api/rest/v1/ ProgramUnitConstraint
constraintTypeId={value}	Constraint Type ID
eduProgramId={value}	Program Code (full/partial)
eduUnitId={value}	Unit Code (full/partial)
constraintEduUnitId={value}	Constraint Unit Code
description={value}	Description (partial match)

Example URL query Criteria	Field
?constraintTypeId=COMPONENT_PROGRAM&eduProgramId=DipBusMgt	Component Programs for a double diploma course
?constraintTypeId=CORE_UNIT&eduProgramId=DipBusMgt	Core units for a program
?constraintTypeId=SUBSTITUTE_UNIT&eduProgramId=DipBusMgt	Substitute units for single programs under a double diploma course
?constraintTypeId=_UNIT&eduProgramId=DipBusMgt	All related units of any type for a program

Code Block
GET https://{host}.edu.net.au/api/rest/v1/ ProgramUnitConstraint constraintTypeId={value} eduProgramId={value} eduUnitId={value} constraintEduUnitId={value} description={value}

Find Unit entity records

Replace {value} with text, join criteria with “&”

Code	Field
GET https://{host}.edu.net.au/api/rest/v1/Unit
eduUnitId={value}	Unit Identifier
unitName={value}	Unit Name (full/partial)
eduOtherUnitId={value}	Unit Code (full/partial
unitStatusId={value}	Unit Status (status identifier)
providerPartyId={value}	Provider (party identifier)
keywords={value}	Keywords text (partial match)

Example URL query Criteria
?unitStatusId=UNIT_INACTIVE	All INACTIVE units
?unitStatusId=UNIT_ACTIVE	All ACTIVE units
?unitStatusId=UNIT_ARCHIVED	All ARCHIVED units
?unitStatusId=UNIT_ACTIVE&eduOtherUnitId=ICB	ACTIVE Units for a Unit Code prefix
?unitStatusId=UNIT_ACTIVE&providerPartyId=10000	ACTIVE Units for a specific Provider

Code Block
GET https://{host}.edu.net.au/api/rest/v1/Unit eduUnitId={value} unitName={value} eduOtherUnitId={value} unitStatusId={value} providerPartyId={value} keywords={value}

Versions Compared

Old Version 3

New Version 4

Key

Create an entity record (HTTP POST method) (template URL for each relevant API entity type)

Create a new ScheduledUnitFee entity record (new API entity to simplify unit fee management)

Update an existing ScheduledUnitFee entity record (new API entity to simplify unit fee management)

Create a new UnitCompetency entity record (new API entity to simplify unit competencies)

Update existing UnitCompetency entity record (new API entity to simplify unit competencies

Create a new Program entity record

Create a new ProgramUnitContraint entity record

Examples for Double Diploma Program entity and related entities

Create a new ProgramUnitContraint entity record

Create a new ProgramUnitContraint entity record

Create a new ProgramUnitContraint entity record

Examples for retrieving listings of entity records

Find Program entity records

Find ProgramUnitConstraint entity records

Find Unit entity records

Further reading

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Create an entity record (HTTP POST method) (template URL for each relevant API entity type)

Create a new ScheduledUnitFee entity record (new API entity to simplify unit fee management)

Update an existing ScheduledUnitFee entity record (new API entity to simplify unit fee management)

Create a new UnitCompetency entity record (new API entity to simplify unit competencies)

Update existing UnitCompetency entity record (new API entity to simplify unit competencies

Create a new Program entity record

Create a new ProgramUnitContraint entity record

Examples for Double Diploma Program entity and related entities

Create a new ProgramUnitContraint entity record

Create a new ProgramUnitContraint entity record

Create a new ProgramUnitContraint entity record

Examples for retrieving listings of entity records

Find Program entity records

Find ProgramUnitConstraint entity records

Find Unit entity records

Further reading