Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Overview


...

CodeField
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

...

CodeField

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) 
}

...


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

...