Overview

• Objective
• Assumptions
• Key terms and concepts
• Implications
• Workflow
• Further reading

Overview of entity types and template URL for each HTTP method

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 an entity record (HTTP POST method) (template URL for each relevant API entity type)

...

POST https://{host}.edu.net.au/api/rest/v1/Program
POST https://{host}.edu.net.au/api/rest/v1/Unit
POST https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint
POST https://{host}.edu.net.au/api/rest/v1/ScheduledUnit 
POST https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee
POST https://{host}.edu.net.au/api/rest/v1/UnitAssessment
POST https://{host}.edu.net.au/api/rest/v1/UnitCompetency
POST https://{host}.edu.net.au/api/rest/v1/Competency
POST https://{host}.edu.net.au/api/rest/v1/CodeItem
POST https://{host}.edu.net.au/api/rest/v1/StatusItem

Update an entity record (HTTP PUT method) (template URL for each relevant API entity type)

...

PUT https://{host}.edu.net.au/api/rest/v1/Program/{eduProgramId}  
PUT https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId} 
PUT https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint/{eduProgramUnitConstraintId}  
PUT https://{host}.edu.net.au/api/rest/v1/ScheduledUnit /{eduScheduledUnitId} 
PUT https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId} 
PUT https://{host}.edu.net.au/api/rest/v1/UnitAssessment /{eduAssessmentId} 
PUT https://{host}.edu.net.au/api/rest/v1/UnitCompetency /{eduAssessmentId} 
PUT https://{host}.edu.net.au/api/rest/v1/Competency /{competencyId} 
PUT https://{host}.edu.net.au/api/rest/v1/CodeItem/{codeId} 
PUT https://{host}.edu.net.au/api/rest/v1/StatusItem/{statusId} 

Retrieve an entity record (HTTP GET Method) (template URL for each relevant API entity type)

...

GET https://{host}.edu.net.au/api/rest/v1/Program/{eduProgramId} 
GET https://{host}.edu.net.au/api/rest/v1/Unit/{eduUnitId} 
GET https://{host}.edu.net.au/api/rest/v1/ProgramUnitConstraint/{eduProgramUnitConstraintId} 
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit /{eduScheduledUnitId} 
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId} 
GET https://{host}.edu.net.au/api/rest/v1/UnitAssessment /{eduAssessmentId} 
GET https://{host}.edu.net.au/api/rest/v1/UnitCompetency /{eduAssessmentId} 
GET https://{host}.edu.net.au/api/rest/v1/Competency /{competencyId} 
GET https://{host}.edu.net.au/api/rest/v1/CodeItem/{codeId} 
GET https://{host}.edu.net.au/api/rest/v1/StatusItem/{statusId} 

Find entity records matching criteria (HTTP GET  method) (template URL for each relevant API entity type)

...

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

Create a new Unit entity record

...

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

...

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 

...

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

...

1. 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 
     
     
2. 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 
     
     
3. 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
     
     
4.  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 
     
     
5. 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 
     
     
6. 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

...

1. 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 
     
     
2. 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 
     
     
3. 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
     
     
4.  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
     
     
5.  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
     
     
6.  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 

...

1. 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
     
     
2.  assessmentTypeId set to COMPETENCY_UNIT
   • assessmentTypeId MAY be provided in the request
   • assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
     
     
3. 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
     
     
4.  assessmentName set to
   • the value of competencyName if provided in the request
   • the defined name of the identified Unit of Competency otherwise
     
     
5.  description set to
   • the value of competencyName if provided in the request
   • the defined name of the identified Unit of Competency otherwise
     
     
6.  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
     
     
7. avet058 set to
   • the value of vetScheduledHours if provided in the request
   • the defined “Nationally Agreed Hours” of the Unit of Competency otherwise
     
     
8.  avet018 set to
   • the value of vetDeliveryMode if provided in the request
   • the value 20 (“Online”) otherwise
     
     
9. 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
10. 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 

...

1. 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
     
     
2. assessmentTypeId cannot be updated:
   • assessmentTypeId MAY be provided in the request
   • assessmentTypeId MUST be COMPETENCY_UNIT if provided in the request
     
     
3. 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
     
     
4. assessmentName set to
   • the value of competencyName if provided in the request
   • the previous value otherwise 
     
     
5. description set to
   • the value of competencyName if provided in the request
   • the previous value of description otherwise
     
     
6. 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
     
     
7. avet058 set to
   • the value of vetScheduledHours if provided in the request
   • the previous value of avet058 otherwise
     
     
8. avet018 set to
   • the value of vetDeliveryMode if provided in the request
   • the previous value of avet018 otherwise
     
     
9. avet078 set to
   • the value of vetInSchoolsFlag if provided in the request
   • the previous value of avet078 otherwise
     
     
10. 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
      
      
11. 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 

...

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 

...

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. 

...

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   Double Diploma COMPONENT PROGRAM 

...

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) 

...

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) 

...

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) 

...

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 “&”

...

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 “&” 

...

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 “&” 

...

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 “&”

...

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 “&” 

...

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 “&” 

...

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 “&” 

...

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 “&” 

...

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 “&” 

...

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

...