Objective
This article outlines how to use the Paradigm API to perform specific tasks through a series of sample POSTMAN commands.
Complexity:
Status | ||||
---|---|---|---|---|
|
Page Contents
Table of Contents | ||||
---|---|---|---|---|
|
Overview of entity types and template URL for each HTTP method
...
Create an entity record (HTTP POST method) (template URL for each relevant API entity type)
CodeTemplate URL | FieldEntity |
---|---|
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 |
...
Update an entity record (HTTP PUT method) (template URL for each relevant API entity type)
CodeTemplate URL | FieldEntity |
---|---|
PUT https://{host}.edu.net.au/api/rest/v1/Program/{eduProgramId} | Program/Course of Study |
PUT https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId} | Unit of Study |
PUT https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint/{eduProgramUnitConstraintId} | Program-Unit Relationship |
PUT https://{host}.edu.net.au/api/rest/v1/ScheduledUnit /{eduScheduledUnitId} | Scheduled Unit of Study |
PUT https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId} | Scheduled Unit Fee |
PUT https://{host}.edu.net.au/api/rest/v1/UnitAssessment /{eduAssessmentId} | Unit of Study Assessment |
PUT https://{host}.edu.net.au/api/rest/v1/UnitCompetency /{eduAssessmentId} | Unit of Study Competency |
PUT https://{host}.edu.net.au/api/rest/v1/Competency /{competencyId} | Unit of Competency |
PUT https://{host}.edu.net.au/api/rest/v1/CodeItem/{codeId} | Code Item |
PUT https://{host}.edu.net.au/api/rest/v1/StatusItem/{statusId} | Status Item |
...
Retrieve an entity record (HTTP GET Method) (template URL for each relevant API entity type)
CodeTemplate URL | FieldEntity |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/Program/{eduProgramId} | Program/Course of Study |
GET https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId} | Unit of Study |
GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint/{eduProgramUnitConstraintId} | Program-Unit Relationship |
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit /{eduScheduledUnitId} | Scheduled Unit of Study |
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId} | Scheduled Unit Fee |
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment /{eduAssessmentId} | Unit of Study Assessment |
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency /{eduAssessmentId} | Unit of Study Competency |
GET https://{host}.edu.net.au/api/rest/v1/Competency /{competencyId} | Unit of Competency |
GET https://{host}.edu.net.au/api/rest/v1/CodeItem/{codeId} | Code Item |
GET https://{host}.edu.net.au/api/rest/v1/StatusItem/{statusId} | Status Item |
...
Find entity records matching criteria (HTTP GET method) (template URL for each relevant API entity type)
CodeTemplate URL | FieldEntity |
---|---|
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 |
...
Create a new Unit entity record
CodeTemplate URL | 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
CodeTemplate URL | 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) |
} |
...
ScheduledUnit and ScheduledFee wrapper
CodeTemplate URL | 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 |
} |
...
ScheduledUnit and ScheduledFee wrapper
CodeTemplate URL | 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 UnitAssessment entity record
CodeTemplate URL | Field |
---|---|
POST https://{host}.edu.net.au/api/rest/v1/UnitAssessment | |
{ | |
"eduUnitId": "ICX1234", | Unit Code (FK to Unit.eduUnitId) |
"assessmentTypeId": "COMPETENCY_UNIT", | Type of the Assessment |
"assessmentName": "Example Assessment Name", | Name of the Assessment |
"codeId": " ABC10203", | Code of the Assessment (optional) |
"statusId": "ASSESSMENT_ACTIVE", | Status (ACTIVE/INACTIVE) |
"description": " Example Assessment Description", | Description of the Assessment |
"maximumMark": " 100", | Maximum Mark (“marked out of”) |
"passMark": " 50", | Pass Mark (“threshold to pass”) |
"weighting": "1.0", | Weighting (relative within Unit) |
"startWeek": "5", | Start Week (of term schedule) |
"endWeek": "7", | EndWeek (of term schedule) |
"avet058": "60", | Scheduled Hours for Assessment |
"avet018": "20", | Mode of Delivery (AVETMISS) |
"avet078": "N" | VET in Schools flag (Y/N) |
} |
...
Update an existing UnitAssessment entity record
CodeTemplate URL | Field |
---|---|
PUT https://{host}.edu.net.au/api/rest/v1/UnitAssessment/{assessmentId} | |
{ | |
"assessmentName": "Example Assessment Name", | Name of the Assessment |
"codeId": "ABC10203", | Code of the Assessment |
"statusId":"ASSESSMENT_ACTIVE", | Status (ACTIVE/INACTIVE) |
"description":"Example Assessment Description", | Description of the Assessment |
"maximumMark":"100", | Maximum Mark (“mark out of”) |
"passMark": "50", | Pass Mark (“mark to pass”) |
"weighting": "1.0", | Weighting (relative within Unit) |
"startWeek": "5", | Start Week (of term schedule) |
"endWeek": "7", | EndWeek (of term schedule) |
"avet058": "60", | Scheduled Hours for Assessment |
"avet018": "20", | Mode of Delivery (AVETMISS) |
"avet078": "N" | VET in Schools flag (Y/N) |
} |
...
UnitAssessment wrapper for COMPETENCY_UNIT
CodeTemplate URL | 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) |
} |
...
UnitAssessment wrapper for COMPETENCY_UNIT
CodeTemplate URL | 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
CodeTemplate URL | 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) |
} |
...
(example for single diploma course outline core unit) Single Diploma CORE UNIT
CodeTemplate URL | 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) |
} |
...
Create a new Program entity record - Double Diploma
CodeTemplate URL | 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) |
} |
...
(only valid for double diploma course outline to define a child single diploma course under the double diploma) Double Diploma COMPONENT PROGRAM
CodeTemplate URL | 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) |
} |
...
(only valid for double diploma course outline to define an exemption unit equivalent to a matching core unit)
CodeTemplate URL | 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) |
} |
...
(example for double diploma course outline core unit)
CodeTemplate URL | 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) |
} |
...
(template URL for each relevant API entity type)
CodeTemplate URL | FieldEntity |
---|---|
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 |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | 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 | FieldDescription |
---|---|
?programStatusId=PROGRAM_ACTIVE | All ACTIVE Programs |
?programStatusId=PROGRAM_INACTIVE | All INACTIVE Programs |
?programStatusId=PROGRAM_ACTIVE&programName=Diploma | ACTIVE Diploma Programs |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | 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 | FieldDescription |
---|---|
?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 |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | 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 | Description |
---|---|
?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 |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | Field |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment | |
assessmentId={value} | Unit Assessment Identifier |
assessmentTypeId={value} | Type of Unit Assessment |
eduUnitId={value} | Unit Code of related Unit |
assessmentName={value} | Name of a Unit Assessment |
statusId={value} | Unit Assessment Status |
...
Example URL query criteria | FieldDescription |
---|---|
?statusId= ASSESSMENT_ARCHIVED | All ARCHIVED Unit Assessments |
?statusId= ASSESSMENT_ACTIVE | All ACTIVE Unit Assessments |
?statusId= ASSESSMENT _ACTIVE&eduUnitId=ICB1233 | ACTIVE Unit Assessments for a Unit Code (whole or prefix) |
?assessmentTypeId=COMPETENCY_UNIT&statusId= ASSESSMENT _ACTIVE | All ACTIVE Unit Competencies |
?assessmentTypeId=COMPETENCY_UNIT&statusId= ASSESSMENT _ACTIVE&eduUnitId=ICB1233 | ACTIVE Unit Competencies for a Unit Code (whole or prefix) |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | Field |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency | |
competencyId={value} | Unit Assessment Identifier |
competencyName={value} | Name of a Unit Competency |
eduUnitId={value} | Unit Code of related Unit |
statusId={value} | Unit Assessment Status |
...
Example URL query criteria | FieldDescription |
---|---|
?statusId= ASSESSMENT_ARCHIVED | All ARCHIVED Unit Competencies |
?statusId= ASSESSMENT_ACTIVE | All ACTIVE Unit Assessments |
?statusId=ASSESSMENT _ACTIVE | All ACTIVE Unit Competencies |
?statusId= ASSESSMENT _ACTIVE&eduUnitId=ICB1233 | ACTIVE Unit Competencies for a Unit Code (whole or prefix) |
...
Example URL query criteria | FieldDescription |
---|---|
?unitStatusId=UNIT_INACTIVE | All INACTIVE Scheduled Units |
?unitStatusId=UNIT_ACTIVE | All ACTIVE Scheduled Units |
?unitStatusId=UNIT_ARCHIVED | All ARCHIVED Scheduled Units |
?unitStatusId=UNIT_ACTIVE&eduOtherUnitId=ICB | ACTIVE Scheduled Units for a Unit Code prefix |
?unitStatusId=UNIT_ACTIVE&providerPartyId=10000 | ACTIVE Scheduled Units for a specific Provider |
?unitStatusId=UNIT_ACTIVE&startDate=2015-01-01 | ACTIVE Scheduled Units for a specific Start Date |
?unitStatusId=UNIT_ACTIVE&startDate=2015-0101&endDate=2015-12-31 | ACTIVE Scheduled Units for specific Start and End Date |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | Field |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledAssessment | |
eduScheduledUnitId={value} | Scheduled Unit Identifier |
assessmentId={value} | Unit Assessment Identifier |
assessmentTypeId={value} | Type of Unit Assessment |
scheduledAssessmentId={value} | Scheduled Unit Assessment Identifier |
scheduledAssessmentStatusId={value} | Unit Assessment Status |
scheduledAssessmentName={value} | Name of a Unit Assessment |
...
Example URL query criteria | FieldDescription |
---|---|
?statusId= ASSESSMENT_ARCHIVED | All ARCHIVED Scheduled Unit Assessments |
?statusId= ASSESSMENT_ACTIVE | All ACTIVE Scheduled Unit Assessments |
?statusId= ASSESSMENT _ACTIVE&eduScheduledUnitId=10123 | ACTIVE Scheduled Unit Assessments for a specific Scheduled Unit |
?assessmentTypeId=COMPETENCY_UNIT&statusId= ASSESSMENT _ACTIVE | All ACTIVE Scheduled Unit Competencies |
?assessmentTypeId=COMPETENCY_UNIT&statusId= ASSESSMENT _ACTIVE&eduScheduledUnitId=10123 | ACTIVE Scheduled Unit Competencies for a specific Scheduled Unit |
...
Replace {value} with text, join criteria with “&”
CodeTemplate URL | Field |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledFee | |
eduScheduledUnitId={value} | Scheduled Unit Identifier |
eduScheduledFeeSeqId={value} | Scheduled Feee Identifier |
eduProgramId={value} | Program Code (full/partial) |
description={value} | Fee Description (full/partial) |
...
Example URL query Criteria | FieldDescription |
---|---|
?eduScheduledUnitId=10123 | All Fees for a Scheduled Unit |
?eduProgramId=DipBus | All Fees for a Program/Course |
?eduScheduledUnitId=10123&eduProgramId=DipBus | All Fees for a Scheduled Unit for a specific Program/Course |
...
(new API entity to simplify unit fee management) Replace {value} with text, join criteria with “&”
CodeTemplate URL | Field |
---|---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee | |
eduScheduledUnitId={value} | Scheduled Unit Identifier |
eduUnitId={value} | Unit Identifier |
unitName={value} | Unit Name (scheduled) |
unitStatusId={value} | Unit Status (scheduled) |
eduOtherUnitId ={value} | Unit Code (scheduled) |
providerPartyId ={value} | Provider (party identifier) |
startDate={value} | Start Date (scheduled) |
endDate={value} | End Date (scheduled) |
destCensusDate={value} | Census Date (scheduled) |
feeTypeId={value} | Fee Type (Code=FEE_TYPE) |
...
Example URL Query criteria | FieldDescription |
---|---|
?unitStatusId=UNIT_INACTIVE | All INACTIVE Scheduled Unit Fees |
?unitStatusId=UNIT_ACTIVE | All ACTIVE Scheduled Unit Fees |
?unitStatusId=UNIT_ARCHIVED | All ARCHIVED Scheduled Unit Fees |
?unitStatusId=UNIT_ACTIVE&eduOtherUnitId=ICB | ACTIVE Scheduled Unit Fees for a Unit Code prefix |
?unitStatusId=UNIT_ACTIVE&providerPartyId=10000 | ACTIVE Scheduled Unit Fees for a specific Provider |
?unitStatusId=UNIT_ACTIVE&startDate=2015-01-01 | ACTIVE Scheduled Unit Fees for a specific Start Date |
?unitStatusId=UNIT_ACTIVE&eduUnitId=ICB1233&startDate=201501-01&endDate=2015-12-31 | ACTIVE Scheduled Unit Fees for a specific Unit and specific Start and End Dates |
?unitStatusId=UNIT_ACTIVE&eduUnitId=ICB1233&startDate=201501-01&endDate=2015-12-31&feeTypeId= STANDARD_FEE | ACTIVE Scheduled Unit Fees for a specific Unit and Fee Type and specific Start and End Dates |
?unitStatusId=UNIT_ACTIVE&eduUnitId=ICB1233&feeTypeId= STANDARD_FEE | ACTIVE Scheduled Unit Fees for a specific Unit and Fee Type (multiple dates may be returned) |
...