{
 "openapi": "3.1.0",
 "info": {
  "title": "ISIR Records (Student Lifecycle)",
  "version": "20261030b",
  "description": "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."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "isir-records": {
    "type": "object",
    "required": [],
    "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
     },
     "import_id": {
      "type": "string",
      "format": "uuid",
      "description": "Import id",
      "readOnly": true
     },
     "line_no": {
      "type": "integer",
      "description": "Line no",
      "readOnly": true
     },
     "award_year": {
      "type": "string",
      "description": "Award year",
      "readOnly": true
     },
     "student_id": {
      "type": "string",
      "format": "uuid",
      "description": "Student id",
      "readOnly": true
     },
     "match_status": {
      "type": "string",
      "description": "Match status",
      "readOnly": true
     },
     "match_method": {
      "type": "string",
      "description": "Match method",
      "readOnly": true
     },
     "transaction_number": {
      "type": "integer",
      "description": "Transaction number",
      "readOnly": true
     },
     "transaction_receipt_date": {
      "type": "string",
      "format": "date",
      "description": "Transaction receipt date",
      "readOnly": true
     },
     "fafsa_uuid": {
      "type": "string",
      "description": "Fafsa uuid",
      "readOnly": true
     },
     "first_name": {
      "type": "string",
      "description": "First name",
      "readOnly": true
     },
     "last_name": {
      "type": "string",
      "description": "Last name",
      "readOnly": true
     },
     "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Date of birth",
      "readOnly": true
     },
     "ssn_cipher": {
      "type": "string",
      "description": "Ssn cipher",
      "readOnly": true
     },
     "ssn_hash": {
      "type": "string",
      "description": "Ssn hash",
      "readOnly": true
     },
     "ssn_last4": {
      "type": "string",
      "description": "Ssn last4",
      "readOnly": true
     },
     "dependency_status": {
      "type": "string",
      "description": "Dependency status",
      "readOnly": true
     },
     "sai": {
      "type": "integer",
      "description": "Sai",
      "readOnly": true
     },
     "sai_formula": {
      "type": "string",
      "description": "Sai formula",
      "readOnly": true
     },
     "pell_eligible": {
      "type": "boolean",
      "description": "Pell eligible",
      "readOnly": true
     },
     "verification_selected": {
      "type": "boolean",
      "description": "Verification selected",
      "readOnly": true
     },
     "verification_group": {
      "type": "string",
      "description": "Verification group",
      "readOnly": true
     },
     "c_flag": {
      "type": "boolean",
      "description": "C flag",
      "readOnly": true
     },
     "c_codes": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "C codes",
      "readOnly": true
     },
     "school_codes": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "School codes",
      "readOnly": true
     },
     "raw_masked": {
      "type": "string",
      "description": "Raw masked",
      "readOnly": true
     },
     "is_current": {
      "type": "boolean",
      "description": "Is current",
      "readOnly": true
     },
     "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
     },
     "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/isir-records": {
   "get": {
    "summary": "list isir-records",
    "operationId": "list_isir_records_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post isir records",
    "operationId": "action_isir_records_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/isir-records/{id}": {
   "get": {
    "summary": "get isir-records",
    "operationId": "get_isir_records_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put isir records",
    "operationId": "action_isir_records_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete isir records",
    "operationId": "action_isir_records_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/isir-records/{id}/match": {
   "post": {
    "summary": "Match",
    "operationId": "action_isir_records_0_6",
    "description": "Body keys: student_id",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/isir-records/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_isir_records_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"
     }
    }
   }
  }
 }
}