Account
| API | Description |
|---|---|
| POST api/Account/Logout |
Logout your account from API |
| POST api/Account/ChangePassword |
Change your account password using with API |
| POST api/Account/Create |
Register/Create new user |
Campus
| API | Description |
|---|---|
| GET api/RTO/Campuses?campusid={campusid}&courseid={courseid}&vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}&refresh={refresh} |
Get all campuses information list [Optional] You can filter campuses result with specific search filter by query strings E.g.
|
| GET api/RTO/Campuses/{id} |
Get campus information by particular campus id |
| GET api/RTO/Campuses/{id}/Venues?vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry} |
Get associated venues/training locations list by specific campus. [Optional] You can filter venues/training locations result with specific search filter by query strings. E.g.
|
| GET api/RTO/Campuses/{id}/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&coursename={coursename}&refresh={refresh}&pagesize={pagesize}¤tpage={currentpage} |
Get associated courses/qualifications information list by specific campus. [Optional] You can filter courses result wiht specific search filter by query strings. E.g.
|
CommLog
| API | Description |
|---|---|
| POST api/RTO/Commlogs/SendmailbyStudent |
SendmailbyStudent :log Communications of staff,student,trainer,agent |
Course
| API | Description |
|---|---|
| GET api/RTO/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&coursename={coursename}&refresh={refresh}&pagesize={pagesize}¤tpage={currentpage} |
Get all courses information list (This will be obsolete from 1/1/2024 onward.) [Optional] You can filter courses result with specific search filter by query strings E.g.
|
| GET api/RTO/Courses/{id} |
Get course information by particular course Id |
| GET api/RTO/Courses/{id}/Campuses?campusid={campusid}&courseid={courseid}&vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}&refresh={refresh} |
Get associated campus list by particular course Id. |
| GET api/RTO/Courses/{id}/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh} |
Get associated intake dates list by particular course Id. |
CourseIntake
| API | Description |
|---|---|
| GET api/RTO/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh} |
Get all course intake date information list. [Suggestion] give course intake search filter value to narrow down data returned. Key filter parameter should be used by default is 'year', 'publish' and 'targetfor' E.g.
|
CourseV2
| API | Description |
|---|---|
| GET api/V2/RTO/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&coursename={coursename}&refresh={refresh}&pagesize={pagesize}¤tpage={currentpage} |
Get all courses information list [Optional] You can filter courses result with specific search filter by query strings E.g.
|
Provider
| API | Description |
|---|---|
| POST api/Providers |
Get all active provider list, who is eligible to link/sync with Mobile App. Use POST method. |
PushNotification
To register the mobile device of student and send push notification
| API | Description |
|---|---|
| POST api/RTO/device/RegisterDevice |
To register the SmartPhone device for push notification purpose POST api/RTO/device/PushNotification |
| POST api/RTO/device/PushNotification |
To send notification message to SmartPhone device POST api/RTO/device/PushNotification |
| GET api/RTO/device/GetRegisteredDevice |
Get registered Mobile device using username and application url Required parameters:
Must be passed in header as part of request. |
SendEmail
| API | Description |
|---|---|
| POST api/RTO/EMail/Send |
Send Email |
SendSMS
| API | Description |
|---|---|
| POST api/RTO/SMS/Send |
Send SMS |
Student
| API | Description |
|---|---|
| GET api/Student/PersonalDetails |
Get student personal information |
| GET api/Student/Courses |
Get student course information list |
| GET api/Student/SubjectEnrolments?cid={cid}&cattempt={cattempt}&subid={subid}&subattempt={subattempt} |
Get student subject activity enrolment information list. This will be used with HigherED course type only. SubjectOutcome,SubjectGrade,SubjectMarks:- Value can be empty if the user set a date at which the Final Grades will automatically be released to Students. |
| GET api/Student/UnitEnrolments?cid={cid}&cattempt={cattempt}&subid={subid}&subattempt={subattempt}&uid={uid} |
Get student subject and unit activity enrolment information list. This will be used other course type, except HigherED course type only. SubjectOutcome,SubjectGrade,SubjectMarks,UnitGrade,UnitCompetency,UnitMarks:- Value can be empty if the user set a date at which the Final Grades will automatically be released to Students. |
| GET api/Student/Timetables?subid={subid}&batch={batch}&day={day}&rmid={rmid}&startdate={startdate}&enddate={enddate}&classdate={classdate}&wkdates={wkdates} |
Get student class timetable information list |
| GET api/Student/ClassDates?fromdate={fromdate}&todate={todate} |
Get student class timetable dates list |
| GET api/Student/PaymentDues?invtype={invtype}&cid={cid}&cattempt={cattempt}&duedate={duedate} |
Get student payment due list |
| GET api/Student/Attendances?cid={cid}&cattempt={cattempt} |
Get student course attendance list. |
| GET api/Student/Assessments?cid={cid}&cattempt={cattempt}&subid={subid}&subattempt={subattempt}&batch={batch}&duedate={duedate} |
Get student assessment task information list SubjectOutcome,SubjectGrade,SubjectMarks,MarksAchieved,AssessmentOutcome:- Value can be empty if the user to a date at which the Final Grades will automatically be released to Students. |
| GET api/Student/NewsReminders?type={type}&annouce={annouce}&startdate={startdate}&enddate={enddate} |
Get news, event, reminders and announcement for student |
| GET api/Student/Messages?id={id}&linkid={linkid}&date={date}&cid={cid}&cattempt={cattempt}&type={type}&pagesize={pagesize}¤tpage={currentpage} |
Get communication message for student |
| GET api/Student/CollegeCampuses?type={type}&suburb={suburb}&state={state}&postcode={postcode}&country={country} |
Get college/campus contact details for student |
StudentV2
| API | Description |
|---|---|
| GET api/V2/Student/Messages?id={id}&linkid={linkid}&date={date}&cid={cid}&cattempt={cattempt}&type={type}&pagesize={pagesize}¤tpage={currentpage} |
Get communication message for student |
| GET api/V2/Student/Attendances?cid={cid}&cattempt={cattempt} |
No documentation available. |
Trainer
| API | Description |
|---|---|
| GET api/Trainer/PersonalDetails |
Get staff personal information |
| POST api/Trainer/UpdateProfile |
Update staff personal information |
| GET api/Trainer/ClassDetails?Semester={Semester}&Term={Term} |
Get Class Trainer |
| GET api/Trainer/StudentsListByClassDetails?ClassId={ClassId}&Week={Week} |
Get student list by class details for trainer |
| GET api/Trainer/StaffCommLog?Type={Type} |
Get staff Communication Log |
| GET api/Trainer/Semester |
Get Semester for Trainer |
| GET api/Trainer/Term?Semester={Semester}&Term={Term} |
Get Semester for Trainer |