Objective
...
Table of Contents | ||||
---|---|---|---|---|
|
Note |
---|
Please note: Additional API examples calls may be viewed here: https://documenter.getpostman.com/view/541303/SW7aXnWL?version=latest |
Overview of entity types and template URL for each HTTP method
...
Template URL | Entity |
---|---|
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 |
...
Template 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) |
} |
...