ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Department

API	Description
GET api/Department/CourseOfStudy?departmentId={departmentId}	Get a List of Courses of Study by Department
GET api/Department/Option?OptionId={OptionId}	Get A Course Option by its Id
GET api/Department/All	Get A List of all departments
GET api/Department/Get/{Id}	Get A Department by its ID
GET api/Department/Faculty?departmentId={departmentId}	Get A Faculty by a Department
GET api/Department/Lecturers?departmentId={departmentId}	Get A List of Lecturer in or without a Department
GET api/Department/Students?departmentId={departmentId}	No documentation available.

Course

API	Description
GET api/Course/GetCourses?sessionId={sessionId}&semesterId={semesterId}
GET api/Course/All
GET api/Course/AllRegisteredCoursesBySession?sessionId={sessionId}

Config

API	Description
GET api/Config/AddSchool?schoolCode={schoolCode}&name={name}&enable={enable}	No documentation available.
GET api/Config/DeleteSchool?schoolCode={schoolCode}	No documentation available.
GET api/Config/ListTenants	No documentation available.

Student

API	Description
GET api/Student/Createstudent?firstName={firstName}&middleName={middleName}&lastName={lastName}&confirmAdmission={confirmAdmission}&sex={sex}&dateOfBirth={dateOfBirth}&countryName={countryName}&stateName={stateName}&regNo={regNo}&matricNo={matricNo}&programName={programName}&courseOfStudyName={courseOfStudyName}&admissionSetName={admissionSetName}&levelName={levelName}&statusName={statusName}&sessionName={sessionName}&campusName={campusName}&modeOfEntryName={modeOfEntryName}&email={email}&password={password}&phoneNumber={phoneNumber}	Returns information of the student attached with the token sent Error 404 is sent if the token is not for student user
POST api/Student/Createstudent	No documentation available.
GET api/Student/CurrentStudent	No documentation available.
GET api/Student/DashBoardDetails?studentId={studentId}&RegNumber={RegNumber}	Get All Dashboard details for the student If optional arguments are not sent, the student with the token is assumed
GET api/Student/PersonalDetailsWitheEmailAndRegNo?studentId={studentId}&Email={Email}&RegNumber={RegNumber}	Get Student Personal Details using studentId or Registration Number/matric Number When both studentId and RegNumber/MatricNumber is not provided, the token sent is used to identify the student
GET api/Student/PersonalDetails?studentId={studentId}&RegNumber={RegNumber}&username={username}	Get Student Personal Details using studentId or Registration Number/matric Number When both studentId and RegNumber/MatricNumber is not provided, the token sent is used to identify the student
GET api/Student/ActiveSession?studentId={studentId}	Get An Active Session for a Student
GET api/Student/Results?semesterId={semesterId}&sessionId={sessionId}&studentId={studentId}&RegNumber={RegNumber}	Gets the results of a student for each semester If none of studentid or regNumber is provided , the student with the token is assumed
GET api/Student/Results?studentId={studentId}	Gets the results of a student for all semesters
GET api/Student/GPA?semesterId={semesterId}&sessionId={sessionId}&studentId={studentId}	Gets the results of a student for each semester
GET api/Student/CGPA?studentId={studentId}	Get the list of CGPA of a student for all sessions
GET api/Student/Payments?sessionId={sessionId}&studentId={studentId}&RegNumber={RegNumber}&sessionName={sessionName}	Get Student Payment breakdown
GET api/Student/RegCourses?studentId={studentId}&regNumber={regNumber}&semesterId={semesterId}&sessionId={sessionId}	No documentation available.
GET api/Student/AvailableCourses?studentId={studentId}&regNumber={regNumber}&semesterId={semesterId}&sessionId={sessionId}	No documentation available.
GET api/Student/RegisteredCourses?studentId={studentId}&regNumber={regNumber}	No documentation available.
GET api/Student/RegisteredCoursesBySessionId?studentId={studentId}&regNumber={regNumber}&sessionId={sessionId}
GET api/Student/CourseRegistration?studentId={studentId}&regNumber={regNumber}&sessionId={sessionId}
GET api/Student/GetAllStudents	No documentation available.

User

API	Description
GET api/User/AllStudentsPersonalDetails	Return the personal details of all the users
GET api/User/GetAllUsers	No documentation available.
GET api/User/PersonalDetails?username={username}	Return the personal details of the user with the access token

Lecturer

API	Description
GET api/Lecturer/CurrentLecturer	No documentation available.
GET api/Lecturer/Courses?sessionId={sessionId}&semesterId={semesterId}&lecturerId={lecturerId}	/
GET api/Lecturer/CourseStudents?sessionId={sessionId}&semesterId={semesterId}&lecturerId={lecturerId}	returns a list of courses and students enrolled
GET api/Lecturer/PersonalDetails?lecturerId={lecturerId}	No documentation available.
GET api/Lecturer/LecturerPersonalDetails?sessionId={sessionId}&semesterId={semesterId}&lecturerId={lecturerId}	No documentation available.

Admission

API	Description
GET api/Admission/All	Get A List of Admission sets in a School

ElasticSearch

API	Description
POST api/ElasticSearch/SearchLogs	No documentation available.

Program

API	Description
GET api/Program/All	Get A List of Programs in a School
GET api/Program/Get?programId={programId}	Get A Program by its ID
GET api/Program/ActiveSemester?programId={programId}&sessionId={sessionId}	Get Active Semester
GET api/Program/ActiveSessionandSemester

StudentStatistics

API	Description
GET api/StudentStatistics/Get	No documentation available.
GET api/StudentStatistics/GetPaymentDetail?startDate={startDate}&endDate={endDate}	No documentation available.

CourseOfStudy

API	Description
GET api/CourseOfStudy/All	Get all the Courses of Study in a School
GET api/CourseOfStudy/ProgramCourseOfStudy	Get all the Courses of Study in a School
GET api/CourseOfStudy/Get?courseOfStudyId={courseOfStudyId}	Get A Course of Study by its Id
GET api/CourseOfStudy/Faculty?CourseofStudyId={CourseofStudyId}	Get A Faculty a Course of Study belongs to
GET api/CourseOfStudy/Program?CourseOfStudyId={CourseOfStudyId}	Get A List of Program with or without a Course of Study ID
GET api/CourseOfStudy/Students?CourseOfStudyId={CourseOfStudyId}	Get A List of Student in A Department, Course of Study and Faculty
POST api/CourseOfStudy/courseOfStudyOption?courseOfStudyOptionId={courseOfStudyOptionId}	Get A List of Course Options with or without a reference Id

Sessions

API	Description
GET api/Sessions/AllSessions	No documentation available.
GET api/Sessions/AllSemesters	No documentation available.

Dashboard

API	Description
GET api/Dashboard/AdmissionStatistics	No documentation available.
GET api/Dashboard/CourseAssignedStatistics	No documentation available.

Level

API	Description
GET api/Level/All	No documentation available.
GET api/Level/Available?programId={programId}	No documentation available.

Faculty

API	Description
GET api/Faculty/Department?facultyId={facultyId}	Get A List of Department by Faculty
GET api/Faculty/All/{Id}	Get A List of Faculty with or without an ID