Overview
The ACCESS API is a subsection of the Triand REST API. Usage of the ACCESS API requires specific security credentials. The API calls supported by the ACCESS API:
| URL | Method | Description |
|---|---|---|
| /Session/powChallenge | GET | Get the Proof-of-Work Challenge |
| /Session/login | POST | Validate Super Admin Credentials, issue JWT |
| /Session/refresh | POST | Validate Super Admin Credentials, issue JWT |
| /Access/studentApplication | POST | Return eSchool data for State-ID |
| /Access/studentPdfUrl | POST | Create PDF for State-ID |
| /Access/studentMatch | POST | Given student profile, return State-IDs w/security questions |
| /Access/studentIdAssign | POST | Given student profile, assign State-ID |
| /Access/studentSend | POST | Send Transcript to College |
| /Access/adminStateIds | POST | Get State-IDs APSCN-ID can access |
| /Access/adminEmailNoticeList | POST | Manage emails that receive notices |
| /Access/adminActivityLog | POST | Get API activity for the last 30 days |
| /Access/adminPrivateSchools | POST | List Private Schools for State |
| /Access/dashboardStudentsInformation | POST | Get catalog information for list of student State-IDs |
| /Access/dashboardDueForGraduationSummaryByDistrictLea | POST | Get summary of students due for graduation by district LEA |
| /Access/dashboardDueForGraduationForDistrictLea | POST | Get student state ids due for graduation for a district LEA |
The following sections describe each API call in detail.
- Exploring with Postman
- Common to all API Calls
- Log-In, Security JWT
- Student Match
- Student Assign State-ID
- Student Get Application Data
- Student Get Transcript PDF
- Student Send Transcript to College
- Get State-IDs for Administrator
- Manage Notice Emails
- Get API Activity Log
- List Private Schools
- Dashboard: Students Information
- Dashboard: Due for Graduation Summary by District LEA
- Dashboard: Due for Graduation for District LEA