API package
Student Lifecycle
The student lifecycle end to end — admissions through teaching, assessment and graduation to alumni, with billing, aid and the safeguards alongside. Bills raise real receivables in Accounting; faculty are real people in HRMS.
62 APIs449 operationsBase path
/api/slcmAcademic Structure
Academic Terms
The calendar everything keys off: registration windows, census, grade deadlines.
GET3 POST3 PUT2 DELETE2
Course Catalog
Every course on offer, with the prerequisites registration actually enforces.
GET3 POST3 PUT2 DELETE2
Programs
What a student is working toward. Requirements drive the degree audit.
GET3 POST3 PUT2 DELETE2
Sections & Scheduling
What is actually offered this term, who teaches it, when it meets and how full it is.
GET5 POST6 PUT3 DELETE3
Admissions
Admissions
Applicants from first inquiry to a decision, and from a decision to a student record.
GET3 POST5 PUT2 PATCH1 DELETE2
Admissions Dashboard
Applications, documents to verify, admitted and enrolled, by programme and entry term — each figure opens the applicants behind it.
GET1
Possible Duplicate Applicants
Every applicant whose name matches another record together with the date of birth or an email or phone — and, where Duplicate Check Settings says so, the same name alone (“Name only”, a lower-confidence match). Open both to compare. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.
GET2 POST3 PUT1 DELETE1
Communication
Completion
Alumni
The relationship after graduation: where they went, and whether they will give or mentor.
GET2 POST2 PUT1 DELETE1
Career Services
Placements, internships and the counseling behind them. Employers are CRM accounts.
GET2 POST2 PUT1 DELETE1
Credentials
What has been conferred, with a verification code a third party can check.
GET2 POST2 PUT1 DELETE1
Graduation
Applications to graduate. Conferring runs the degree audit as a gate, not a formality.
GET2 POST3 PUT1 DELETE1
Transcript Management
Requests for the academic record. A transcript hold stops issue until it is cleared.
GET2 POST3 PUT1 DELETE1
Early Alerts & Analytics
Alert Rules
When an early alert is raised without anybody pressing anything: attendance under the school’s minimum, absences in a row, fees past due — and when an overdue bill puts a hold on the student. One rule per school, or one for the whole company.
GET2 POST2 PUT1 DELETE1
Early Alerts
Difficulty flagged early enough to act on. Raised by staff, and automatically: on a failing grade, on attendance under the school’s Alert Rules, and on fees past due — one open alert per student and reason.
GET2 POST3 PUT1 DELETE1
Examinations
Exam Periods
The weeks exams are sat in, their daily sittings and rules. Generate the exams, schedule them (a preview on Timetable Runs), then publish to the student portal.
GET3 POST6 PUT2 DELETE2
Exams
Each exam: who sits it, when, in which rooms (a large exam is split across rooms) and who invigilates. A change that gives a student two exams at once, too many in a day, or a room more candidates than exam seats is refused. An exam shows as scheduled only once it has a date, rooms seating every candidate and an invigilator; until then it stays unscheduled.
GET4 POST4 PUT3 DELETE3
Faculty & Advising
Academic Advising
Advising sessions, what was discussed and what was agreed.
GET2 POST2 PUT1 DELETE1
Faculty
Who teaches and who advises, with their current load. Linked to the HRMS personnel record.
GET2 POST2 PUT1 DELETE1
Teaching Teams
Who teaches a section besides its lead: co-teachers, demonstrators, tutors, lab instructors and examiners. Each may take the section’s register, set its work and enter its marks, and has it on their own timetable. Nobody is put in two classes at once.
GET2 POST2 PUT1 DELETE1
Financial Aid (US)
Aid Applications
One per student per award year, from the ISIR: SAI, cost of attendance, need, verification and C-code status. Propose a package, offer it, and the student answers in the portal.
GET3 POST5 PUT1 DELETE1
Aid Tasks
What must be cleared before federal aid is paid: verification, ISIR comment codes, ISIRs that matched nobody, over-awards.
GET2 POST3 PUT1 DELETE1
Award Years
Federal award years (July to June) with the maximum and minimum Pell and the institutional grant limit.
GET2 POST2 PUT1 DELETE1
Cost of Attendance
Budgets per award year by enrolment intensity and housing, each a list of components: tuition and fees, housing and food, books and supplies, transportation, personal, loan fees, dependent care. The seeded amounts are illustrative.
GET3 POST3 PUT2 DELETE2
Direct Loan Limits
Annual Direct Subsidized and combined limits by grade level and dependency. Check them against the FSA Handbook for the award year.
GET2 POST2 PUT1 DELETE1
ISIR Imports
ISIR files loaded: how many records, how many matched a student, what could not be read.
GET2 POST3 PUT1 DELETE1
ISIR Layouts
Where each ISIR field sits, per award year, as data. Check every position against the ED ISIR Guide for the year before importing a real file; a new award year is a new layout.
GET3 POST3 PUT2 DELETE2
ISIR Records
Each ISIR transaction received, the student it matched (by SSN, else date of birth and name) and what it says: SAI, dependency, Pell eligibility, verification, C-codes. The SSN shows as its last four.
GET2 POST3 PUT1 DELETE1
Pell Schedule
Annual Pell by Student Aid Index and enrolment intensity. The seeded schedule is ILLUSTRATIVE: replace it with the schedule the Department of Education publishes for the award year.
GET2 POST2 PUT1 DELETE1
Money
Aid Awards
What was offered, accepted and disbursed. Accepted aid reduces the next bill.
GET2 POST3 PUT1 DELETE1
Fee Schedule
What is charged, on what basis, and to which general ledger account.
GET2 POST2 PUT1 DELETE1
Financial Aid & Scholarships
Where aid money comes from and how much of each fund is left. Linked to funding sources in Budgeting.
GET2 POST2 PUT1 DELETE1
Overdue Student Bills
Every bill past its due date with money still open: how late, whether the student and finance were warned, its late fee and its hold. The late fee comes from the Fee Schedule (a fee of type Late), the hold from Alert Rules — neither is charged or placed unless the school has set one.
GET2 POST4 PUT1 DELETE1
Student Billing
A term’s charges netted against aid. Issuing raises a real receivable in Accounting. Partially paid: the payer has paid something. Partially credited: only a credit note or refund has reduced it. Paid: closed, with a payment toward it. Credited: closed by credit notes alone.
GET3 POST5 PUT2 DELETE2
Term Billing
Bill every enrolled student of a term — or of one programme in it — in one go. Preview first: who is billed, for how much, and who is passed over and why. A student already billed for the term is never billed twice.
GET2 POST4 PUT1 DELETE1
Records
Reporting
Rooms & Timetabling
Buildings
The buildings rooms are in, each on a campus.
GET2 POST2 PUT1 DELETE1
Meeting Patterns
What the timetable builder is asked to place for a section: hours a week, session length, preferred days, room type and equipment. A section without one keeps the shape of the meetings it has.
GET2 POST2 PUT1 DELETE1
Room Bookings
One-off events asked for a room: a guest lecture, a society, an interview day. Approved, a booking holds the room like a class does; a clash is refused when it is approved.
GET2 POST5 PUT1 DELETE1
Room Closures
Dates a room cannot be used: refurbishment, an open day, a fault. The timetable and bookings are refused over them.
GET2 POST2 PUT1 DELETE1
Rooms
Every room that can be timetabled or examined in: seats, exam seats, type, equipment, step-free access and opening hours. A room is booked by the timetable, never typed.
GET2 POST2 PUT1 DELETE1
Scheduling Settings
Whether an over-full room warns or is refused, whether student clashes are checked, the teaching day the builder works in, and the exam rules.
GET2 POST2 PUT1 DELETE1
Timetable
The timetable as a calendar — week, day or month — for you, a section, a teacher, a room, a student or a programme; each class opens its register. The weekly pattern, with the clashes marked, is one press away.
GET3
Timetable Runs
The automatic builder: build a conflict-free timetable for a term as a preview, see what it could not place and why, then apply it or throw it away. Exam scheduling runs land here too.
GET3 POST5 PUT1 DELETE1
Services and actions
Early alerts,
The early alerts, service of Student Lifecycle: 1 operation(s).
GET1
Portal
The portal service of Student Lifecycle: 2 operation(s).
GET1 POST1
Register
The register service of Student Lifecycle: 1 operation(s).
POST1
Teaching
The teaching service of Student Lifecycle: 3 operation(s).
GET3
Students
Duplicate Check Settings
Whether students or applicants who share only a name (no matching date of birth, email or phone) are also flagged as possible duplicates. Such a match is lower-confidence: it is listed as “Name only” and said as a warning when a record is saved, but it never stops a save and never merges records. Case, accents and extra spaces are ignored when names are compared.
GET2 POST2 PUT1 DELETE1
Holds & Compliance
What stops a student registering, obtaining a transcript or graduating.
GET2 POST3 PUT1 DELETE1
My Studies
Your courses, your attendance in each, and the work set for you — hand an essay in here.
GET1
Possible Duplicate Students
Every student whose name matches another record together with the date of birth or an email or phone — and, where Duplicate Check Settings says so, the same name alone (“Name only”, a lower-confidence match). Open both to compare. Different people: choose Not a duplicate and say why (or say why when saving with Create anyway), and the pair leaves this list.
GET2 POST3 PUT1 DELETE1
Registration
Every registration, waitlist place and grade.
GET2 POST3 PUT1 DELETE1
Student Records
The record itself: program, advisor, standing, credits, GPA and what is blocking progress.
GET5 POST6 PUT2 PATCH1 DELETE2
Teaching & Delivery
Assessments
Quizzes, midterms and final examinations, with their results.
GET3 POST4 PUT2 PATCH1 DELETE2
Assignments
Work set — essays, quizzes, practicals, projects — with what was handed in and the marks given. A teacher sets work only for the sections they teach.
GET3 POST4 PUT2 PATCH1 DELETE2
Attendance
Overall attendance, students and sections under the minimum, and today’s registers — then by programme, section and student, with each student’s cumulative percentage and every class they were marked for.
GET1
Attendance Marks
Each class’s mark per student, with the student’s cumulative attendance in that section up to that day. The figures, by programme, section and student, are on Attendance.
GET2 POST3 PUT1 PATCH1 DELETE1
Class Sessions
Every class held or cancelled, what was taught, and who took the register. Taken on My Teaching or from a class on the timetable calendar.
GET2 POST2 PUT1 DELETE1
Discussions
Discussion threads within a section — the collaborative side of course delivery.
GET3 POST3 PUT2 DELETE2
My Teaching
Your courses and the sections you teach — today’s classes, registers to take, students under the attendance minimum and work to mark first; then each section’s register, students, work and marks.
GET1