{
 "openapi": "3.1.0",
 "info": {
  "title": "Student Records (Student Lifecycle)",
  "version": "20261030b",
  "description": "The record itself: program, advisor, standing, credits, GPA and what is blocking progress."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "students": {
    "type": "object",
    "required": [
     "first_name",
     "last_name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "location_id": {
      "type": "string",
      "format": "uuid",
      "description": "Campus"
     },
     "student_no": {
      "type": "string",
      "description": "Student no",
      "readOnly": true
     },
     "applicant_id": {
      "type": "string",
      "format": "uuid",
      "description": "Applicant id",
      "readOnly": true
     },
     "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "Portal sign-in"
     },
     "first_name": {
      "type": "string",
      "description": "First name"
     },
     "last_name": {
      "type": "string",
      "description": "Last name"
     },
     "preferred_name": {
      "type": "string",
      "description": "Preferred name"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Date of birth"
     },
     "nationality": {
      "type": "string",
      "description": "Nationality"
     },
     "address": {
      "type": "string",
      "description": "Address"
     },
     "emergency_contact": {
      "type": "string",
      "description": "Emergency contact"
     },
     "program_id": {
      "type": "string",
      "format": "uuid",
      "description": "Program"
     },
     "advisor_id": {
      "type": "string",
      "format": "uuid",
      "description": "Advisor"
     },
     "admit_term_id": {
      "type": "string",
      "format": "uuid",
      "description": "Admit term"
     },
     "expected_graduation_term_id": {
      "type": "string",
      "format": "uuid",
      "description": "Expected graduation"
     },
     "enrollment_status": {
      "type": "string",
      "description": "Load",
      "enum": [
       "full_time",
       "part_time",
       "not_enrolled"
      ]
     },
     "status": {
      "type": "string",
      "description": "Status"
     },
     "cumulative_credits": {
      "type": "string",
      "format": "decimal",
      "description": "Cumulative credits",
      "readOnly": true
     },
     "cumulative_gpa": {
      "type": "string",
      "format": "decimal",
      "description": "Cumulative gpa",
      "readOnly": true
     },
     "academic_standing": {
      "type": "string",
      "description": "Academic standing"
     },
     "residency": {
      "type": "string",
      "description": "Residency",
      "enum": [
       "in_state",
       "out_of_state",
       "international"
      ]
     },
     "cohort": {
      "type": "string",
      "description": "Cohort"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "aid_grade_level": {
      "type": "integer",
      "description": "Aid grade level",
      "readOnly": true
     },
     "housing_plan": {
      "type": "string",
      "description": "Housing plan",
      "readOnly": true
     },
     "account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Account id",
      "readOnly": true
     },
     "sponsor_account_id": {
      "type": "string",
      "format": "uuid",
      "description": "Fees billed to (sponsor)"
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/slcm/students": {
   "get": {
    "summary": "list students",
    "operationId": "list_students_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create students",
    "operationId": "create_students_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}": {
   "get": {
    "summary": "get students",
    "operationId": "get_students_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change students",
    "operationId": "change_students_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete students",
    "operationId": "delete_students_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "patch": {
    "summary": "Patch student records",
    "operationId": "action_students_3_5",
    "description": "Body keys: confirm_duplicate, duplicate_reason, review_later",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_students_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{parentId}/onboarding": {
   "get": {
    "summary": "Onboarding",
    "operationId": "action_students_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Onboarding",
    "operationId": "action_students_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{parentId}/onboarding/{lineId}": {
   "put": {
    "summary": "Onboarding",
    "operationId": "action_students_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Onboarding",
    "operationId": "action_students_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/degree-audit": {
   "get": {
    "summary": "Degree audit",
    "operationId": "action_students_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/bill-term": {
   "post": {
    "summary": "Bill term",
    "operationId": "action_students_0_6",
    "description": "Body keys: termId, dueDate",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/holds": {
   "post": {
    "summary": "Holds",
    "operationId": "action_students_0_6",
    "description": "Body keys: holdType*, reason, blocksRegistration, blocksTranscript, blocksGraduation; holdType one of financial|academic|disciplinary|health|library|advising|document|immunization",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/transcript": {
   "get": {
    "summary": "Transcript",
    "operationId": "action_students_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/students/{id}/transition-to-alumni": {
   "post": {
    "summary": "Transition to alumni",
    "operationId": "action_students_0_6",
    "description": "Body keys: graduationYear, email, phone",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}