Overview
...
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} &{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 Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/Program?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/Unit?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/Competency ?{fieldName}={value} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/CodeItem?codeTypeId={codeTypeId} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} GET https://{host}.edu.net.au/api/rest/v1/StatusItem? statusTypeId={ statusTypeId} &{fieldName}={value}&{fieldName}={value}&{fieldName}={value}&{fieldName}={value} |
Examples for Unit 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
...
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) |
} |
...
SCHEDULED UNIT: If a value for any of the following data fields are NOT specified when creating a ScheduledUnit entity record then the value will default to the corresponding data field on the existing Unit entity record referenced by the "eduUnitId" field: "eduOtherUnitId", "eduProviderOtherUnitId", "unitName", "unitStatusId", "providerPartyId"
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) |
} |
...
Create a new ScheduledUnitFee entity record (new API entity to simplify unit fee management)
ScheduledUnit and ScheduledFee wrapper
...
A list of all ScheduledAssessment entity records created will be returned in the JSON document of the HTTP response in an derived array field named scheduledAssessments. This derived array field cannot be used when creating or updating any ScheduledUnitFee entity or ScheduledUnit entity record via the API. Any ScheduledAssessment entity records listed in this derived field must be updated using HTTP PUT calls directly to the relevant individual ScheduledAssessment API URL for that entity record.
Update an existing ScheduledUnitFee entity record (new API entity to simplify unit fee management)
ScheduledUnit and ScheduledFee wrapper
...
A list of all ScheduledAssessment entity records created will be returned in the JSON document of the HTTP response in a derived array field named scheduledAssessments. This derived array field cannot be used when updating any ScheduledUnitFee entity or ScheduledUnit entity record via the API. Any ScheduledAssessment entity records listed in this derived field must be updated using HTTP PUT calls directly to the relevant individual ScheduledAssessment API URL for that entity record.
Create a new UnitAssessment entity record
Code | 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) |
} |
...
- assessmentId set to an auto-generated identifier
- assessmentId MUST NOT be provided in the request
- assessmentId SHOULD be used to identify the new record in other HTTP requests
- assessmentTypeId set to the value provided in the request
- assessmentTypeId MUST be provided in the request
- assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
- statusId set to
- the value of statusId if provided in the request
- ASSESSMENT_ACTIVE otherwise
- statusId MUST be a valid ASSESSMENT_STATUS if provided in the request
- maximumMark set to the value 100
- maximumMark MAY be provided in the request as a numeric value greater than 0
- maximumMark MUST be less than or equal to 100 if provided in the request
- passMark set to the value 50
- passMark MAY be provided in the request as a numeric value greater than 0
- passMark MUST be less than or equal to maximumMark if provided in the request
- all other data fields will be set to
- o the value of matching field name if provided in the request
- the null value otherwise
Update an existing UnitAssessment entity record
Code | 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) |
} |
...
- assessmentId cannot be updated:
- assessmentId MAY be provided in the request body
- assessmentId MUST be the same as in the URL if provided in the request body
- assessmentTypeId set to the value provided in the request
- assessmentTypeId MUST be provided in the request
- assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
- statusId set to
- the value of statusId if provided in the request
- ASSESSMENT_ACTIVE otherwise
- statusId MUST be a valid ASSESSMENT_STATUS if provided in the request
- maximumMark set to the value 100
- maximumMark MAY be provided in the request as a numeric value greater than 0
- maximumMark MUST be less than or equal to 100 if provided in the request
- passMark set to the value 50
- passMark MAY be provided in the request as a numeric value greater than 0
- passMark MUST be less than or equal to maximumMark if provided in the request
- all other data fields will be set to
- the value of matching field name if provided in the request
- the null value otherwise
Create a new UnitCompetency entity record (new API entity to simplify unit competencies)
...
UnitAssessment wrapper for COMPETENCY_UNIT
...
- assessmentId set to an auto-generated identifier
- assessmentId MUST NOT be provided in the request
- assessmentId SHOULD be used to identify the new record in other HTTP requests
- assessmentTypeId set to COMPETENCY_UNIT
- assessmentTypeId MAY be provided in the request
- assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
- codeId set to the value of competencyId
- competencyId MUST be provided in the request
- competencyId MUST be a valid nationally recognised Unit of Competency identifier
- assessmentName set to
- the value of competencyName if provided in the request
- the defined name of the identified Unit of Competency otherwise
- description set to
- the value of competencyName if provided in the request
- the defined name of the identified Unit of Competency otherwise
- statusId set to
- the value of statusId if provided in the request
- ASSESSMENT_ACTIVE otherwise
- statusId MUST be a valid ASSESSMENT_STATUS if provided in the request
- avet058 set to
- the value of vetScheduledHours if provided in the request
- the defined “Nationally Agreed Hours” of the Unit of Competency otherwise
- avet018 set to
- the value of vetDeliveryMode if provided in the request
- the value 20 (“Online”) otherwise
- avet078 set to
- the value of vetInSchoolsFlag if provided in the request
- the value N (“No”) otherwise - maximumMark set to the value 100
- maximumMark MAY be provided in the request as a numeric value greater than 0
- maximumMark MUST be less than or equal to 100 if provided in the request
- passMark set to the value 100
- passMark MAY be provided in the request as a numeric value greater than 0
- passMark MUST be less than or equal to maximumMark if provided in the request
Update existing UnitCompetency entity record (new API entity to simplify unit competencies)
UnitAssessment wrapper for COMPETENCY_UNIT
...
- assessmentId cannot be updated:
- assessmentId MAY be provided in the request body
- assessmentId MUST be the same as in the URL if provided in the request body
- assessmentTypeId cannot be updated:
- assessmentTypeId MAY be provided in the request
- assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
- codeId set to the value of competencyId if provided in the request
- competencyId MAY be provided in the request
- competencyId SHOULD NOT be the same as the previous value if provided
- competencyId MUST be a valid nationally recognised Unit of Competency identifier
- the previous value codeId otherwise
- assessmentName set to
- the value of competencyName if provided in the request
- the previous value otherwise
- description set to
- the value of competencyName if provided in the request
- the previous value of description otherwise
- statusId set to
- the value of statusId if provided in the request
- statusId MUST be a valid ASSESSMENT_STATUS if provided in the request
- the previous value of statusId otherwise
- avet058 set to
- the value of vetScheduledHours if provided in the request
- the previous value of avet058 otherwise
- avet018 set to
- the value of vetDeliveryMode if provided in the request
- the previous value of avet018 otherwise
- avet078 set to
- the value of vetInSchoolsFlag if provided in the request
- the previous value of avet078 otherwise
- maximumMark o maximumMark MAY be provided in the request as a numeric value greater than 0
- maximumMark MUST be less than or equal to 100 if provided in the request
- the previous value of maximumMark otherwise
- passMark
- passMark MAY be provided in the request as a numeric value greater than 0
- passMark MUST be less than or equal to maximumMark if provided in the request
- the previous value of passMark otherwise
Examples for Single 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
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 | ||
---|---|---|
| ||
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 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.
...
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 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 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 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 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 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 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 Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/Unit eduUnitId={value}Eaxmple URL nitName={value} eduOtherUnitId={value} unitStatusId={value} providerPartyId={value} keywords={value} |
Find UnitAssessment entity
...
records
Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment assessmentId={value} assessmentTypeId={value} eduUnitId={value} assessmentName={value} statusId={value} |
Find UnitCompetency entity
...
records
Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency competencyId={value} competencyName={value} eduUnitId={value} statusId={value} |
Find ScheduledUnit entity
...
records
Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit eduScheduledUnitId={value} eduUnitId={value} Identifier unitName={value} unitStatusId={value} eduOtherUnitId ={value} providerPartyId ={value} startDate={value} endDate={value} destCensusDate={value} |
Find ScheduledAssessment entity
...
records
Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledAssessment eduScheduledUnitId={value} assessmentId={value} assessmentTypeId={value} scheduledAssessmentId={value} scheduledAssessmentStatusId={value} scheduledAssessmentName={value} |
Find ScheduledFee entity
...
records
Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledFee eduScheduledUnitId={value} eduScheduledFeeSeqId={value} eduProgramId={value} description={value} |
Find ScheduledUnitFee entity
...
records
(new API entity to simplify unit fee management) Replace {value} with text, join criteria with “&”
...
Code Block |
---|
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee eduScheduledUnitId={value} eduUnitId={value} unitName={value} unitStatusId={value} eduOtherUnitId ={value} providerPartyId ={value} startDate={value} endDate={value} destCensusDate={value} feeTypeId={value} |
Find Entity entity
...
records
Code |
---|
GET https://{sitename}.edu.net.au/api/rest/v1/{EntityName} |
name1={value} |
name2={value} |
name3={value} |
name4={value} |
...
Code Block |
---|
GET https://{sitename}.edu.net.au/api/rest/v1/{EntityName} name1={value} name2={value} name3={value} name4={value} |
Further reading
...