Overview
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)
...
| 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 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)
...
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 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
...
POST https://{host}.edu.net.au/api/rest/v1/Unit
...
| 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 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
...
"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 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 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:
...
- o the value of matching field name if provided in the request
- the null value otherwise
Update an existing UnitAssessment entity record
...
| 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.
...
- 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 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:
...
- 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 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 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:
...
- 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 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.
Create a new Program entity record - Double Diploma
...
| 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.
...
(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 “&”
...
All ACTIVE Unit Competencies
...
| 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 “&”
...
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 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 “&”
...
Fee Type (Code=FEE_TYPE)
...
| 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
...
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' |