Objective
Complexity:
| Status | ||||
|---|---|---|---|---|
|
Page Contents
| Table of Contents | ||||
|---|---|---|---|---|
|
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.
...
API Entity Record Types
...
Brief Description
...
Program
...
Program : a Program/Course of Study definition
...
ProgramUnitConstraint
...
Program-Unit Constraint : rule relating Programs and Units Unit
...
ScheduledUnit
...
Scheduled Unit : a Unit of Study delivered, by method and period
...
ScheduledFee
...
Scheduled Fee : define a fee per ScheduledUnit/Program/FeeType
...
ScheduledUnitFee
...
Scheduled Unit Fee : API entity only, wraps the two types above
...
UnitAssessment
...
Unit Assessment : An Assessment task assigned to a Unit of Study
...
UnitCompetency
...
Unit Competency : A Competency type of Unit Assessment
...
Competency
...
Competency : A nationally defined Unit of Competency
...
CodeItem
...
Code Item (multiple types) : used for various look-up attributes
...
StatusItem
...
Status Item (multiple types) : used for status look-up attributes
Create an entity record (HTTP POST method) (template URL for each relevant API entity type)
...
Code
...
Field
...
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
| Code Block | ||
|---|---|---|
| ||
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)
...
Code
...
Field
...
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
| Code Block | ||
|---|---|---|
| ||
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)
...
Code
...
Field
...
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
| Code Block | ||
|---|---|---|
| ||
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)
...
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
Create a new Unit entity 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)
...
}
| Code Block | ||
|---|---|---|
| ||
POST
https://{host}.edu.net.au/api/rest/v1/Unit
{
"eduUnitId": "ICX1234", Unit Code (Primary key, fixed)
"eduOtherUnitId": "ICX1234",
"eduProviderOtherUnitId": "ICX1234",
"unitName": "Example Unit Name",
"unitCategory": "2",
"unitStatusId": "UNIT_ACTIVE",
"providerPartyId": "10000",
"creditStatement": "",
"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"
} |
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)
...
}
| Code Block | ||
|---|---|---|
| ||
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
...
Code
...
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
...
}
| Code Block | ||
|---|---|---|
| ||
POST
https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee
{
"eduUnitId": "ICX1234",
"eduOtherUnitId": "ICX1234",
"eduProviderOtherUnitId": "ICX1234",
"unitName": "Example Unit Name",
"unitStatusId": "UNIT_ACTIVE",
"providerPartyId": "10000",
"startDate" : "20150101T00:00:00",
"endDate" : "20151231T00:00:00",
"fee": "1000.00",
"feeTypeId": "STANDARD_FEE",
"description": "Standard Fee",
"modeOfDelivery": "ONLINE",
"flexibleLearning": "Y",
"maximumParticipants": "10000"
} |
SCHEDULED UNIT FEE: When a POST call is made to the API to create a ScheduledUnitFee entity it actually creates a ScheduledUnit entity record and also create attached ScheduledFee and ScheduledAssessment entity records matching the specification associated with the Unit record.
...
Update an existing ScheduledUnitFee entity record (new API entity to simplify unit fee management)
ScheduledUnit and ScheduledFee wrapper
...
Code
...
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
...
}
| Code Block | ||
|---|---|---|
| ||
PUT
https://{host}.edu.net.au/api/rest/v1/ScheduledUnitFee/{eduScheduledUnitId}
{
"eduProviderOtherUnitId": "ICX1234",
"unitName": "Example Unit Name",
"unitStatusId": "UNIT_ACTIVE",
"providerPartyId": "10000",
"startDate" : "20150101T00:00:00",
"endDate" : "20151231T00:00:00",
"fee": "1000.00",
"feeTypeId": "STANDARD_FEE",
"description": "Standard Fee",
"modeOfDelivery": "ONLINE",
"flexibleLearning": "Y",
"maximumParticipants": "10000"
} |
SCHEDULED UNIT FEE: When a PUT call is made to the API to create a ScheduledUnitFee entity it actually updates the ScheduledUnit entity record identified by the value of the eduScheduledUnitId field value in the URL. It may also create and/or update any ScheduledFee or ScheduledAssessment entity records attached to that ScheduledUnit entity record (i.e. record with a foreign key field named eduScheduledUnitId with the same identifier value.
...
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)
...
}
| Code Block | ||
|---|---|---|
| ||
POST
https://{host}.edu.net.au/api/rest/v1/UnitAssessment
{
"eduUnitId":"ICX1234",
"assessmentTypeId":"COMPETENCY_UNIT",
"assessmentName":"Example Assessment Name",
"codeId":"ABC10203",
"statusId":"ASSESSMENT_ACTIVE",
"description":"Example Assessment Description",
"maximumMark":"100",
"passMark":"50",
"weighting":"1.0",
"startWeek":"5",
"endWeek":"7",
"avet058":"60",
"avet018":"20",
"avet078":"N"
} |
UNIT ASSESSMENT: When a POST call is made to the API to create a UnitAssessment entity it actually creates an Assessment entity record attached to the existing Unit (of study) record identified by the specified value of the eduUnitId field.
The new Assessment entity record will have data field values set as follows:
assessmentId set to an auto-generated identifier
...
assessmentId MUST NOT be provided in the request
...
assessmentTypeId set to the value provided in the request
...
assessmentTypeId MUST be provided in the request
...
statusId set to
...
the value of statusId if provided in the request
...
ASSESSMENT_ACTIVE otherwise
...
maximumMark set to the value 100
...
maximumMark MAY be provided in the request as a numeric value greater than 0
...
passMark set to the value 50
...
passMark MAY be provided in the request as a numeric value greater than 0
...
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)
...
}
| Code Block | ||
|---|---|---|
| ||
PUT
https://{host}.edu.net.au/api/rest/v1/UnitAssessment/{assessmentId}
{
"assessmentName": "Example Assessment Name",
"codeId": " ABC10203",
"statusId": "ASSESSMENT_ACTIVE",
"description":" Example Assessment Description",
"maximumMark": " 100",
"passMark": " 50", "weighting": "1.0",
"startWeek": "5",
"endWeek": "7",
"avet058": "60",
"avet018": "20",
"avet078": "N"
} |
UNIT ASSESSMENT: When a PUT call is made to the API to update a UnitAssessment entity it actually updates the Assessment entity record record identified by the specified value of the assessmentId data field specified in the URL. The identified Assessment entity record will have data field values set to the value of matching field name if provided in the request.
...
assessmentId cannot be updated:
...
assessmentId MAY be provided in the request body
...
assessmentTypeId set to the value provided in the request
...
assessmentTypeId MUST be provided in the request
...
statusId set to
...
the value of statusId if provided in the request
...
ASSESSMENT_ACTIVE otherwise
...
maximumMark set to the value 100
...
maximumMark MAY be provided in the request as a numeric value greater than 0
...
passMark set to the value 50
...
passMark MAY be provided in the request as a numeric value greater than 0
...
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
...
Code
...
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)
...
}
| Code Block |
|---|
POST
https://{host}.edu.net.au/api/rest/v1/UnitCompetency
{
"eduUnitId": "ICX1234",
"competencyId": "ABC10203",
"competencyName": "Example Competency Name",
"statusId": "ASSESSMENT_ACTIVE",
"description": "Example Competency Description",
"vetScheduledHours": "60",
"vetDeliveryMode": "20",
"vetInSchoolsFlag": "N"
} |
UNIT COMPETENCY: When a POST call is made to the API to create a UnitCompetency entity it actually creates a Assessment entity record attached to the existing Unit (of study) record identified by the specified value of the eduUnitId field.
The new Assessment entity record will have data field values set as follows:
assessmentId set to an auto-generated identifier
...
assessmentId MUST NOT be provided in the request
...
assessmentTypeId set to COMPETENCY_UNIT
...
assessmentTypeId MAY be provided in the request
...
codeId set to the value of competencyId
...
competencyId MUST be provided in the request
...
assessmentName set to
...
the value of competencyName if provided in the request
...
description set to
...
the value of competencyName if provided in the request
...
statusId set to
...
the value of statusId if provided in the request
...
ASSESSMENT_ACTIVE otherwise
...
avet058 set to
...
the value of vetScheduledHours if provided in the request
...
avet018 set to
...
the value of vetDeliveryMode if provided in the request
...
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
...
Code
...
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)
...
}
| Code Block | ||
|---|---|---|
| ||
PUT
https://{host}.edu.net.au/api/rest/v1/UnitCompetency/{assessmentId}
{
"competencyId": "ABC10203",
"competencyName": "Example Competency Name",
"statusId": "ASSESSMENT_ACTIVE",
"description": "Example Competency Description",
"vetScheduledHours": "60",
"vetDeliveryMode": "20",
"vetInSchoolsFlag": "N"
} |
UNIT COMPETENCY: When a PUT call is made to the API to update a UnitCompetency entity it actually updates the Assessment entity record identified by the specified value of the assessmentId field in the URL.
The updated Assessment entity record will have data field values set as follows:
assessmentId cannot be updated:
...
assessmentId MAY be provided in the request body
...
assessmentTypeId cannot be updated:
...
assessmentTypeId MAY be 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
...
assessmentName set to
...
the value of competencyName if provided in the request
...
description set to
...
the value of competencyName if provided in the request
...
statusId set to
...
the value of statusId if provided in the request
...
statusId MUST be a valid ASSESSMENT_STATUS if provided in the request
...
avet058 set to
...
the value of vetScheduledHours if provided in the request
...
avet018 set to
...
the value of vetDeliveryMode if provided in the request
...
avet078 set to
...
the value of vetInSchoolsFlag if provided in the request
...
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
...
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
...
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)
...
}
| 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.
Create a new Program entity record - Double Diploma
...
Code
...
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)
...
}
| 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
...
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)
...
}
| 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
...
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)
...
}
| 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
...
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)
...
}
| 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
...
Field
...
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
| 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
...
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
...
Field
...
?programStatusId=PROGRAM_ACTIVE
...
All ACTIVE Programs
...
?programStatusId=PROGRAM_INACTIVE
...
All INACTIVE Programs
...
?programStatusId=PROGRAM_ACTIVE&programName=Diploma
...
ACTIVE Diploma Programs
| 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
...
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
...
Field
...
?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
| 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
...
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
...
?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
| 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
...
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
...
Field
...
?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)
| 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
...
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
...
Field
...
?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)
| 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
...
Field
...
GET https://{host}.edu.net.au/api/rest/v1/ScheduledUnit
...
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)
...
Example URL query criteria
...
Field
...
?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
| 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
...
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
...
Field
...
?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
| 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
...
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
...
Field
...
?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
| 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
...
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
...
Field
...
?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)
| 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}
...
Example URL query criteria
...
?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} |
...
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Related Pages
...
Objective
This article outlines how to use the Paradigm API to perform specific tasks through a series of sample POSTMAN commands.
Complexity:
| Status | ||||
|---|---|---|---|---|
|
| Note |
|---|
Be AdvisedThe Paradigm API examples calls may be viewed in the format of a Postman Collection available via this link: https://documenter.getpostman.com/view/541303/TVRpz4qD |
| Info |
|---|
Advanced programmers that are familiar with connecting to APIs are welcome to dive straight in using the postman documentation for reference. |
Getting started
When reading the documentation you’ll notice contents such as {{apiUser}} , these will need to be populated with values that would exist only on your Paradigm system. If you are making use of Postman to test call executions, this is how Postman represents environment variables.
Common Variables
Variable Name | Description | Example Content |
|---|---|---|
apiUser | This is the username of the user you wish to use the API with. |
|
apiPw | The password for the user |
|
host | The hostname of your site | https://abc.edu.net.au |
Logging In
| Note |
|---|
BE ADVISED Do not use online tools to generate your base64 encoded logins as these 3rd party sites may store the login credential resulting in a significant risk to the security of your Paradigm site. |
To use the API you will need to set the HTTP Authorization header as “Basic {{encodedPassString}}”. The encoded pass string is a base64 encoded form of the following information: username:password
Use the following examples as a guide on how to correctly generate a base64 encoded text string. Replace the parameters username and password with the values you want to use on your Paradigm site.
Windows Command Prompt:
| Code Block | ||
|---|---|---|
| ||
powershell "[convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes(\"username:password\")) |
Windows PowerShell:
| Code Block | ||
|---|---|---|
| ||
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("username:password")) |
Linux Bash:
| Code Block | ||
|---|---|---|
| ||
echo 'username:password' | base64 |
Example Requests
In the top menu, you have the option to select the LANGUAGE - as in the programming language or method that you will be using to connect to the API.
By default this is curl:
| Code Block | ||
|---|---|---|
| ||
curl --location -g --request GET 'https://host/api/rest/EduNoteData/?partyId={{sampleStudentPartyId}}' \
--header 'Content-Type: application/json' |