Be prepared

Energy Space APIs

Integrations with other systems

exemplarsystems.jpeg

Purpose

The purpose of this document is to define the Lighthouse webservice endpoints. The endpoints return data related to a students:

  • Formative results and progress;

  • Summative results;

  • Student unit status (Competence, Academically complete or not yet competent);

  • Formative and summative results mapping to training package requirements, including knowledge and skills, critical aspects and performance criteria;

  • eProfiling progress against each unit;

  • eProfiling exceptions (missing cards etc); and

  • Student creation.

The client may utilise student information for their own recording and analysis or to generate a custom reporting system on a students academic, profiling and skills formative, summative progress and unit completion status.
The service allow data to be used to automatically update the Student Management System at an RTO.

WSDL

http://lighthouse.energyspace.com.au/LighthouseWebServices/LighthouseService?wsdl

End points

  • login(String username, String password, String system)

  • logout(String sessionId)

  • assignStudentToClass(String sessionId, String moodleId, String groupId)

  • createLMSStudent(String sessionId, String username, String password, String firstName, String lastname, String emailaddress, String dateOfBirth, String rtoIdentifier)

  • getStudents(String sessionId)

  • getTeachers(String sessionId, int rtoId)

  • getStudentSkillsTestTemplate(String sessionId, String unitCode, String studentMoodleId)

  • submitSkillsTest(String sessionId, String unitCode, String studentMoodleId, String skillsTestString)

  • getStudentUnits(String sessionId, String studentMoodleId)

  • getStudentPreviousSkillsTestResults(String sessionId, String unitCode, String studentMoodleId)

  • getSkillsTestResult(String sessionId, String ustId)

  • getAllUnits(String sessionId)

  • getClassInfoByUnitCode(String sessionId, String unitCode)

  • getStudentUKTResults(String sessionId, String studentMoodleId, String unitCode)

  • getUKTTestResult(String sessionId, String examId)

  • getTopicQuizResult(String sessionId, String examId)

  • getStudentUnitStatus(String sessionId, String moodleId, String unitCode)

  • getStudentResults(String sessionId, String moodleId)

  • getStudentUnitCompetence(String sessionId, String moodleId, String unitCode)

  • getStudentByClassAndUnit(String sessionId, String classID, String unitcode)

  • getEProfilingBulkReportDetails(String sessionId, String qualification, String regNo)

  • getEProfilingApprenticeExceptions(String sessionId, String regNo, String qualification)

  • getEProfilingStudentDetails(String sessionId)

  • generateBulkReport(String sessionId, String rtoId, String qualificationNo)

  • getWSWACMStudentStatus(String sessionId, String usi)

  • getWSWACMNetwork(String sessionId)

  • enrolClassInUnit(String sessionId, String classId, String unitCode)

  • createNewClass(String sessionId, String className)

  • getClasses(String sessionId)

  • setRTOIdentifier(String sessionId, String moodleId, String rtoIdentifier)

  • getRTOStudentEvidenceUploadMapping(String sessionId, String unitCode, String moodleId)

  • getStudentCompetenciesReport(String sessionId)

  • getUnitGroups(String sessionId)

  • getLatestUnits(String sessionId)

  • getFutureAssessments(String sessionId)

  • getUpcomingReadinessAssesmentSessions(String sessionId)

  • getRTOWSWACMClasses(String sessionId)

  • getDailyPassword(String sessionId)

  • getSupportText(String sessionId)

  • getServiceStatus()

  • getReportPermission(String sessionId, String reportName)

  • getStudent(String sessionId, int moodleId)

  • getProfilingStudent(String sessionId, String eProfilingRegNo)

  • getExamStudent(String sessionId, int examId)

  • getReadinessAssessmentResults(String sessionId, int moodleId, String quiztype)

  • getStudentUnitProfilingStatus(String sessionId, String unitCode, String eProfilingId)

  • getStudentEnrolledUnits(String sessionId, int moodleId)

  • getUnit(String sessionId, int unitId)

  • getClassMembers(String sessionId, int classId)

  • getClassUnitAssessmentSessions(String sessionId, int unitId, int classId)

  • getClassUnit(String sessionId, int unitId, int classId)

  • getEProfilingCardCalcs(String sessionId, String profilingIdentifier)

  • createReadinessAssessmentSession(String sessionId, String assessmentType, String state, String sessionDate, String sessionTime, String location, String note)

  • createAssessmentSession(String sessionId, int unitId, String location, String assessmenttime, String state, String assessmentdate)

  • enrolStudentInAssessmentSession(String sessionId, int assessmentSessionId, int uktCourseId, int moodleId)

  • unenrolStudentInAssessmentSession(String sessionId, int assessmentSessionId, int uktCourseId, int moodleId)

  • getStudentsNotInGroup(String sessionId, int classId)

  • lowPerformingQuestions(String sessionId, int unitId, int classId)

  • getUnitTopics(String unitCode,String sessionId)

  • getCHCPerformanceCriteria(String sessionId, String unitCode)

  • getCHCPerformanceEvidence(String sessionId, String unitCode)

  • suspendAccount(String sessionId, int moodleId)

  • reOpenAccount(String sessionId, int moodleId)

  • getUnitKnowledgeSkillsTopicElements(String sessionId, String unitCode)

  • getClassUnitSummary(String sessionId, int unitId, int classId)

  • getUpcomingSessions(String sessionId, int unitId)

  • getBestReadinessAssessmentResult(String sessionId, int moodleId)

  • getStudentDocumentAccess(String sessionId, int moodleId)

  • getStudentUnitSkillsTestTemplate(String sessionId, String unitCode)

  • getUnitProjectPlanTemplate(String sessionId, String unitCode)

  • getStudentTopicSkillsPractices(String sessionId, int moodleId, String unitCode)

  • getULPAccess(String sessionId, String unitCode, int classId)

  • getUnitDocuments(String sessionId, String unitCode)

  • getStudentPerformanceCriteria(String sessionId, int moodleId, int unitId)

  • getStudentCriticalAspects(String sessionId, int moodleId, String unitCode)

  • getPerformanceCriteria(String sessionId, String unitCode)

  • getRTODefinedEvidenceMapping(String sessionId, String unitCode, int moodleId)

  • getStudentUnitEvidence(String sessionId, String moodleId, String unitCode, int unitId)

  • getStudentAlerts(String sessionId, int moodleId)

  • getUnitCodeQuizzes(String sessionId, String unitCode )

  • getUnitTopicSkillsPractices(String sessionId, String unitCode )

  • getUnitQuizzes(String sessionId, int unitId )

  • getClassSummary(String sessionId, int classId, int unitId)

  • getClassProfiling(String sessionId, int classId, String unitCode)

  • getUnitKnowledgeWorkingOut(String sessionId, String unitCode, int examId)

  • getStudentUnitTransactions(String sessionId, int moodleId, String unitCode)

  • getUnitRequiredKnowledge(String sessionId, String unitCode)

  • getUnitRequiredSkills(String sessionId, String unitCode)

  • getUnitCriticalAspectsForAssessment(String sessionId, String unitCode)

  • getStudentVUUnitMapping(String sessionId, int moodleId, String unitCode)

  • getStudentECGUnitMapping(String sessionId, int moodleId, String unitCode)

  • getUnitRangeStatement(String sessionId, String unitCode)

  • getUnitKnowledgeEvidence(String sessionId, String unitCode)

  • getUnitPerformanceEvidence(String sessionId, String unitCode)

  • getVUUnitPerformanceCriteria(String sessionId, String unitCode)

  • getUnitKnowledgeTests(String sessionId, String unitCode)

  • setStudentUnitCompetence(String sessionId, String unitCode, int moodleId, String competenceText, String comment)

  • setStudentUnitSkillsTests(String sessionId, String testResults)

  • setStudentUSI(String sessionId, String moodleId, String usi)

  • setStudentPassportNumber(String sessionId, String moodleId, String studentpassportnumber)

  • isExistingAccount(String sessionId, String username, String email)

  • getStudentTopicLearningActivities(String sessionId, int moodleId, String unitCode)

  • getStudentUnitSkillsTest(String sessionId, int examId)

  • getGroup(String sessionId, int groupId)

  • releaseResult(String sessionId, int examId, boolean released, String releaseComment)

  • setClassStartDate(String sessionId, int classId, String unitCode, String startDate)

  • removeStudentFromClass(String sessionId, int classId, int moodleId)

  • updateClassName(String sessionId, int classId, String className)

  • overrideQuestionResult(String sessionId, int examId, int questionId, float overrideValue, String comment)

  • removeOverrideQuestionResult(String sessionId, int examId, int questionId)

  • getAssessmentReadinessPredictor(String sessionId, int moodleId, int unitId)

  • acceptUKTSuspiciousActivity(String sessionId, int examId)

  • geteProfilingCardDifferential(String sessionId, String qualification, int fromtime)