API endpoints: Student Lifecycle
The 52 Student Lifecycle resources: their published and service-account paths, what may be done with each, and every field with its type.
Every Student Lifecycle resource another product can reach, 52 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/slcm/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.
Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.
கல்வி கட்டமைப்பு
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Academic Terms (terms) | /api/v1/terms · /api/slcm/terms · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, academic_year text, term_type text, start_date* date, end_date* date, registration_opens date, registration_closes date, add_drop_deadline date, withdraw_deadline date, census_date date, grades_due date, status text, is_current boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Course Catalog (courses) | /api/v1/courses · /api/slcm/courses · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, title* text, credits numeric, level text, description text, learning_outcomes text, grading_scheme text, contact_hours numeric, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Programs (programs) | /api/v1/programs · /api/slcm/programs · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, code* text, name* text, degree_type text, level text, credits_required numeric, min_gpa numeric, duration_terms integer, catalog_year text, delivery_mode text, cost_center_id uuid, description text, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Sections & Scheduling (sections) | /api/v1/sections · /api/slcm/sections · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, section_no text (read-only), course_id* uuid, term_id* uuid, faculty_id uuid, delivery_mode text, capacity integer, waitlist_capacity integer, enrolled_count integer (read-only), waitlist_count integer (read-only), room text, status text, cost_center_id uuid, syllabus text, room_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
சேர்க்கைகள்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Admissions (applicants) | /api/v1/applicants · /api/slcm/applicants · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, applicant_no text (read-only), first_name* text, last_name* text, preferred_name text, email text, phone text, date_of_birth date, nationality text, address text, program_id uuid, term_id uuid, application_date date, source text, prior_school text, prior_gpa numeric, test_score numeric, status text, decision_date date (read-only), decision_by uuid (read-only), decision_notes text, rating numeric, student_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Possible Duplicate Applicants (applicant-duplicates) | /api/v1/applicant-duplicates · /api/slcm/applicant-duplicates · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid (read-only), applicant_no text (read-only), first_name text (read-only), last_name text (read-only), preferred_name text (read-only), email text (read-only), phone text (read-only), date_of_birth date (read-only), nationality text (read-only), address text (read-only), program_id uuid (read-only), term_id uuid (read-only), application_date date (read-only), source text (read-only), prior_school text (read-only), prior_gpa numeric (read-only), test_score numeric (read-only), status text (read-only), decision_date date (read-only), decision_by uuid (read-only), decision_notes text (read-only), rating numeric (read-only), student_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
தொடர்பு
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Student Communication (communications) | /api/v1/communications · /api/slcm/communications · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), message_no text (read-only), subject* text, body text, channel text, audience text, audience_ref text, student_id uuid, section_id uuid, status text, scheduled_at timestamp with time zone, sent_at timestamp with time zone (read-only), recipient_count integer (read-only), sent_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
நிறைவு
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Alumni (alumni) | /api/v1/alumni · /api/slcm/alumni · /{id} | list, get, create, change, delete | id uuid (read-only), student_id* uuid, graduation_year text, program_id uuid, current_employer text, current_title text, industry text, email text, phone text, address text, mentor_willing boolean, donor_status text, lifetime_giving numeric, engagement_score numeric, last_contact_at date, notes text, transitioned_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Career Services (career-records) | /api/v1/career-records · /api/slcm/career-records · /{id} | list, get, create, change, delete | id uuid (read-only), student_id* uuid, record_type text, employer text, employer_account_id uuid, job_title text, employment_type text, salary numeric, currency text, start_date date, status text, counsellor_id uuid, notes text, recorded_at timestamp with time zone (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Credentials (credentials) | /api/v1/credentials · /api/slcm/credentials · /{id} | list, get | id uuid (read-only), credential_no text (read-only), student_id uuid (read-only), program_id uuid (read-only), credential_type text (read-only), title text (read-only), conferred_on date (read-only), honors text (read-only), final_gpa numeric (read-only), credits_earned numeric (read-only), verification_code text (read-only), status text (read-only), issued_by uuid (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Graduation (graduation-applications) | /api/v1/graduation-applications · /api/slcm/graduation-applications · /{id} | list, get, create, change, delete | id uuid (read-only), application_no text (read-only), student_id* uuid, program_id uuid, term_id uuid, applied_at date (read-only), status text, audit_result jsonb (read-only), reviewed_by uuid (read-only), reviewed_at timestamp with time zone (read-only), ceremony_date date, honors text, notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Transcript Management (transcripts) | /api/v1/transcripts · /api/slcm/transcripts · /{id} | list, get, create, change, delete | id uuid (read-only), request_no text (read-only), student_id* uuid, transcript_type text, requested_at timestamp with time zone (read-only), delivery_method text, recipient text, recipient_email text, fee_amount numeric, status text, issued_at timestamp with time zone (read-only), issued_by uuid (read-only), hold_reason text (read-only), org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
ஆரம்ப எச்சரிக்கைகள் மற்றும் பகுப்பாய்வுகள்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Alert Rules (alert-rules) | /api/v1/alert-rules · /api/slcm/alert-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid, name text, attendance_min_pct numeric, attendance_critical_pct numeric, consecutive_absences integer, min_sessions integer, overdue_warn_days integer, overdue_hold_days integer, hold_blocks_registration boolean, hold_blocks_transcript boolean, hold_blocks_graduation boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Early Alerts (early-alerts) | /api/v1/early-alerts · /api/slcm/early-alerts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), alert_no text (read-only), student_id* uuid, section_id uuid, raised_by uuid (read-only), alert_type text, severity text, reason* text, detail text, status text, assigned_to uuid, raised_at timestamp with time zone (read-only), resolved_at timestamp with time zone (read-only), resolution text, is_automatic boolean (read-only), source text (read-only), dedupe_key text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
தேர்வுகள்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Exam Periods (exam-periods) | /api/v1/exam-periods · /api/slcm/exam-periods · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), period_no text (read-only), name* text, term_id* uuid, start_date* date, end_date* date, exam_days _text, max_exams_per_day integer, seats_per_invigilator integer, status text (read-only), published_at timestamp with time zone (read-only), published_by uuid (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Exams (exams) | /api/v1/exams · /api/slcm/exams · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), exam_no text (read-only), period_id* uuid, section_id uuid, course_id uuid, assessment_id uuid, title* text, exam_type text, duration_minutes integer, needs_room_type text, exam_date date, start_time time without time zone, end_time time without time zone, keep_fixed boolean, status text (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
ஆசிரியர்கள் மற்றும் ஆலோசனை
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Academic Advising (advising) | /api/v1/advising · /api/slcm/advising · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), session_no text (read-only), student_id* uuid, advisor_id uuid, term_id uuid, scheduled_at timestamp with time zone, held_at timestamp with time zone, session_type text, status text, topics text, notes text, action_plan text, follow_up_date date, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Faculty (faculty) | /api/v1/faculty · /api/slcm/faculty · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), employee_id uuid, faculty_no text (read-only), first_name* text, last_name* text, email text, rank text, appointment text, tenure_status text, specialization text, max_load_credits numeric, office_location_id uuid, is_advisor boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Teaching Teams (section-faculty) | /api/v1/section-faculty · /api/slcm/section-faculty · /{id} | list, get, create, change, delete | id uuid (read-only), section_id* uuid, faculty_id* uuid, teaching_role text, notes text, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
நிதி உதவி (அமெரிக்கா)
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Aid Applications (aid-applications) | /api/v1/aid-applications · /api/slcm/aid-applications · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), application_no text (read-only), student_id* uuid, award_year* text, current_isir_id uuid (read-only), transaction_number integer (read-only), sai integer (read-only), dependency_status text (read-only), pell_eligible boolean (read-only), verification_status text (read-only), verification_group text (read-only), c_code_status text (read-only), intensity text, housing text, grade_level integer, coa_budget_id uuid (read-only), coa_amount numeric (read-only), other_aid numeric, need numeric (read-only), proposed_package jsonb (read-only), status text (read-only), offered_at timestamp with time zone (read-only), responded_at timestamp with time zone (read-only), notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Aid Tasks (aid-tasks) | /api/v1/aid-tasks · /api/slcm/aid-tasks · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), task_no text (read-only), application_id uuid, student_id uuid, isir_record_id uuid (read-only), task_type* text, code text, description* text, status text (read-only), due_date date, resolved_by uuid (read-only), resolved_at timestamp with time zone (read-only), resolution text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Award Years (award-years) | /api/v1/award-years · /api/slcm/award-years · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, start_date* date, end_date* date, max_pell numeric, min_pell numeric, institutional_grant_max numeric, federal_school_code text, is_current boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Cost of Attendance (coa-budgets) | /api/v1/coa-budgets · /api/slcm/coa-budgets · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, award_year* text, intensity text, housing text, residency text, level text, total_amount numeric (read-only), is_illustrative boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Direct Loan Limits (loan-limits) | /api/v1/loan-limits · /api/slcm/loan-limits · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), award_year* text, grade_level* integer, dependency* text, subsidized_max numeric, combined_max numeric, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ISIR Imports (isir-imports) | /api/v1/isir-imports · /api/slcm/isir-imports · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), import_no text (read-only), award_year text (read-only), layout_id uuid (read-only), file_name text (read-only), record_count integer (read-only), matched_count integer (read-only), unmatched_count integer (read-only), error_count integer (read-only), errors jsonb (read-only), status text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ISIR Layouts (isir-layouts) | /api/v1/isir-layouts · /api/slcm/isir-layouts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, award_year* text, record_length* integer, source_note text, is_active boolean, verified_against_guide boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| ISIR Records (isir-records) | /api/v1/isir-records · /api/slcm/isir-records · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), import_id uuid (read-only), line_no integer (read-only), award_year text (read-only), student_id uuid (read-only), match_status text (read-only), match_method text (read-only), transaction_number integer (read-only), transaction_receipt_date date (read-only), fafsa_uuid text (read-only), first_name text (read-only), last_name text (read-only), date_of_birth date (read-only), ssn_cipher bytea (read-only), ssn_hash text (read-only), ssn_last4 text (read-only), dependency_status text (read-only), sai integer (read-only), sai_formula text (read-only), pell_eligible boolean (read-only), verification_selected boolean (read-only), verification_group text (read-only), c_flag boolean (read-only), c_codes _text (read-only), school_codes _text (read-only), raw_masked text (read-only), is_current boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Pell Schedule (pell-schedule) | /api/v1/pell-schedule · /api/slcm/pell-schedule · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), award_year* text, intensity* text, sai_from* integer, sai_to* integer, annual_amount* numeric, is_illustrative boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
பணம்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Aid Awards (aid-awards) | /api/v1/aid-awards · /api/slcm/aid-awards · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), award_no text (read-only), student_id* uuid, aid_program_id* uuid, term_id uuid, academic_year text, amount_offered numeric, amount_accepted numeric, amount_disbursed numeric (read-only), status text, offered_at date (read-only), responded_at date (read-only), disbursed_at date (read-only), conditions text, cost_center_id uuid, application_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Fee Schedule (fee-schedule) | /api/v1/fee-schedule · /api/slcm/fee-schedule · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, fee_type text, basis text, amount numeric, currency text, program_id uuid, residency text, level text, gl_account_id uuid, cost_center_id uuid, effective_from date, effective_to date, is_active boolean, org_unit_id uuid (read-only), late_after_days integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Financial Aid & Scholarships (aid-programs) | /api/v1/aid-programs · /api/slcm/aid-programs · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, aid_type text, source text, funding_source_id uuid, total_budget numeric, awarded_total numeric (read-only), need_based boolean, merit_based boolean, renewable boolean, min_gpa numeric, criteria text, is_active boolean, org_unit_id uuid (read-only), federal_kind text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Overdue Student Bills (overdue-bills) | /api/v1/overdue-bills · /api/slcm/overdue-bills · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), bill_no text (read-only), student_id uuid (read-only), term_id uuid (read-only), bill_date date (read-only), due_date date (read-only), gross_charges numeric (read-only), aid_applied numeric (read-only), net_due numeric (read-only), currency text (read-only), status text (read-only), ar_invoice_id uuid (read-only), cost_center_id uuid (read-only), notes text (read-only), amount_settled numeric (read-only), late_fee_for uuid (read-only), late_fee_id uuid (read-only), amount_paid numeric (read-only), amount_credited numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Student Billing (student-bills) | /api/v1/student-bills · /api/slcm/student-bills · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), bill_no text (read-only), student_id uuid (read-only), term_id uuid (read-only), bill_date date (read-only), due_date date (read-only), gross_charges numeric (read-only), aid_applied numeric (read-only), net_due numeric (read-only), currency text (read-only), status text (read-only), ar_invoice_id uuid (read-only), cost_center_id uuid (read-only), notes text (read-only), amount_settled numeric (read-only), late_fee_for uuid (read-only), late_fee_id uuid (read-only), amount_paid numeric (read-only), amount_credited numeric (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Term Billing (term-billing) | /api/v1/term-billing · /api/slcm/term-billing · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), code text (read-only), name text (read-only), academic_year text (read-only), term_type text (read-only), start_date date (read-only), end_date date (read-only), registration_opens date (read-only), registration_closes date (read-only), add_drop_deadline date (read-only), withdraw_deadline date (read-only), census_date date (read-only), grades_due date (read-only), status text (read-only), is_current boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
பிற வளங்கள்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Grade scale (grade-scale) | /api/v1/grade-scale · /api/slcm/grade-scale · /{id} | list, get, create, change, delete | id uuid (read-only), grade* text, grade_points* numeric, min_percent numeric, max_percent numeric, counts_toward_gpa boolean, earns_credit boolean, is_passing boolean, sort_order integer, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
அறைகள் மற்றும் நேர அட்டவணை
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Buildings (buildings) | /api/v1/buildings · /api/slcm/buildings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, location_id uuid, address text, floors integer, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Meeting Patterns (meeting-patterns) | /api/v1/meeting-patterns · /api/slcm/meeting-patterns · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), section_id* uuid, hours_per_week numeric, session_minutes integer, preferred_days _text, earliest_start time without time zone, latest_end time without time zone, room_type text, required_features _text, needs_accessible boolean, expected_size integer, cohort_tag text, keep_fixed boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Room Bookings (room-bookings) | /api/v1/room-bookings · /api/slcm/room-bookings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), booking_no text (read-only), room_id* uuid, title* text, purpose text, event_date* date, start_time* time without time zone, end_time* time without time zone, attendees integer, requested_by uuid (read-only), contact text, status text (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Room Closures (room-blackouts) | /api/v1/room-blackouts · /api/slcm/room-blackouts · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), blackout_no text (read-only), room_id* uuid, starts_at* timestamp with time zone, ends_at* timestamp with time zone, reason* text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Rooms (rooms) | /api/v1/rooms · /api/slcm/rooms · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name text, building_id uuid, location_id uuid, floor text, room_type text, capacity integer, exam_capacity integer, features _text, is_accessible boolean, accessibility_notes text, available_days _text, available_from time without time zone, available_to time without time zone, is_bookable boolean, is_active boolean, notes text, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Scheduling Settings (scheduling-settings) | /api/v1/scheduling-settings · /api/slcm/scheduling-settings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), capacity_mode text, capacity_basis text, student_clash_mode text, teaching_days _text, day_starts time without time zone, day_ends time without time zone, slot_minutes integer, builder_time_limit_ms integer, max_exams_per_day integer, exam_gap_minutes integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Timetable Runs (timetable-runs) | /api/v1/timetable-runs · /api/slcm/timetable-runs · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), run_no text (read-only), term_id uuid (read-only), run_kind text (read-only), status text (read-only), scope jsonb (read-only), placements jsonb (read-only), unplaceable jsonb (read-only), skipped jsonb (read-only), stats jsonb (read-only), sections_in_scope integer (read-only), sessions_placed integer (read-only), unplaceable_count integer (read-only), elapsed_ms integer (read-only), applied_at timestamp with time zone (read-only), applied_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
மாணவர்கள்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Duplicate Check Settings (duplicate-settings) | /api/v1/duplicate-settings · /api/slcm/duplicate-settings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), name_only_students boolean, name_only_applicants boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Holds & Compliance (holds) | /api/v1/holds · /api/slcm/holds · /{id} | list, get, create, change, delete | id uuid (read-only), student_id* uuid, hold_type* text, reason* text, blocks_registration boolean, blocks_transcript boolean, blocks_graduation boolean, placed_at timestamp with time zone (read-only), placed_by uuid (read-only), released_at timestamp with time zone (read-only), released_by uuid (read-only), release_note text, is_active boolean, org_unit_id uuid (read-only), bill_id uuid (read-only), source text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Possible Duplicate Students (student-duplicates) | /api/v1/student-duplicates · /api/slcm/student-duplicates · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid (read-only), student_no text (read-only), applicant_id uuid (read-only), user_id uuid (read-only), first_name text (read-only), last_name text (read-only), preferred_name text (read-only), email text (read-only), phone text (read-only), date_of_birth date (read-only), nationality text (read-only), address text (read-only), emergency_contact text (read-only), program_id uuid (read-only), advisor_id uuid (read-only), admit_term_id uuid (read-only), expected_graduation_term_id uuid (read-only), enrollment_status text (read-only), status text (read-only), cumulative_credits numeric (read-only), cumulative_gpa numeric (read-only), academic_standing text (read-only), residency text (read-only), cohort text (read-only), aid_grade_level integer (read-only), housing_plan text (read-only), account_id uuid (read-only), sponsor_account_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Registration (enrollments) | /api/v1/enrollments · /api/slcm/enrollments · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), student_id uuid (read-only), section_id uuid (read-only), term_id uuid (read-only), enrolled_at timestamp with time zone (read-only), status text (read-only), credits numeric (read-only), grade text (read-only), grade_points numeric (read-only), quality_points numeric (read-only), graded_at timestamp with time zone (read-only), graded_by uuid (read-only), dropped_at timestamp with time zone (read-only), drop_reason text (read-only), waitlist_position integer (read-only), is_repeat boolean (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Student Records (students) | /api/v1/students · /api/slcm/students · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), location_id uuid, student_no text (read-only), applicant_id uuid (read-only), user_id uuid, first_name* text, last_name* text, preferred_name text, email text, phone text, date_of_birth date, nationality text, address text, emergency_contact text, program_id uuid, advisor_id uuid, admit_term_id uuid, expected_graduation_term_id uuid, enrollment_status text, status text, cumulative_credits numeric (read-only), cumulative_gpa numeric (read-only), academic_standing text, residency text, cohort text, aid_grade_level integer (read-only), housing_plan text (read-only), account_id uuid (read-only), sponsor_account_id uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
கற்பித்தல் மற்றும் வழங்குதல்
| வளம் | Endpoints | செயல்பாடுகள் | வயல்கள் |
|---|---|---|---|
| Assessments (assessments) | /api/v1/assessments · /api/slcm/assessments · /{id} | list, get, create, change, delete | id uuid (read-only), section_id* uuid, title* text, assessment_type text, scheduled_at timestamp with time zone, duration_minutes integer, points_possible numeric, weight_pct numeric, room text, location_id uuid, is_published boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Assignments (assignments) | /api/v1/assignments · /api/slcm/assignments · /{id} | list, get, create, change, delete | id uuid (read-only), section_id* uuid, assignment_no text (read-only), title* text, description text, assignment_type text, points_possible numeric, weight_pct numeric, assigned_date date, due_at timestamp with time zone, allow_late boolean, late_penalty_pct numeric, is_published boolean, org_unit_id uuid (read-only), word_limit integer, rubric text, requires_declaration boolean, declaration_text text, submission_mode text, set_by uuid, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Attendance Marks (attendance) | /api/v1/attendance · /api/slcm/attendance · /{id} | list, get, create, change, delete | id uuid (read-only), section_id* uuid, student_id* uuid, meeting_date* date, status text, minutes_late integer, recorded_by uuid (read-only), notes text, recorded_at timestamp with time zone (read-only), org_unit_id uuid (read-only), session_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Class Sessions (class-sessions) | /api/v1/class-sessions · /api/slcm/class-sessions · /{id} | list, get | id uuid (read-only), org_unit_id uuid (read-only), section_id uuid (read-only), meeting_id uuid (read-only), session_date date (read-only), start_time time without time zone (read-only), end_time time without time zone (read-only), room_id uuid (read-only), faculty_id uuid (read-only), topic text (read-only), status text (read-only), notes text (read-only), marked_at timestamp with time zone (read-only), marked_by uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Discussions (discussions) | /api/v1/discussions · /api/slcm/discussions · /{id} | list, get, create, change, delete | id uuid (read-only), section_id uuid, title* text, topic text, is_locked boolean, is_graded boolean, org_unit_id uuid (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |