Overview
OneFile provides a range of API endpoints for third-party integrations. These endpoints allow external systems to interact with OneFile data for tasks such as creating, retrieving, updating, and searching records.
Available API Endpoints
| Level | Object | Endpoints |
|---|---|---|
| Customer | Customer | Authenticate |
| Organisation (Centre) | Assessment Template | Get / Search |
| Classroom | Create / Get / Update / Search | |
| Framework Template | Get / Search | |
| Grade Ranges & Grades | Search | |
| Learner Status | Get | |
| Learning Aim Status | Get | |
| Organisation | Get / Search | |
Placement | Create / Get / Update / Search | |
Plan Template | Get | |
| Provider | Create / Get / Update / Search | |
| Registers | Create / Get / Update / Add Attendee / Remove Attendee / Archive / Unarchive / Delete | |
| Standard | Get / Search | |
Timesheet Category | Get | |
| Unit | Get / Search | |
| All Users | User | Create / Get / Update / Search |
| Learners | Assessment Template | Assign |
| Break-in-Learning | Create / Update | |
| Delivery Plan | Assign | |
| Framework Template | Assign | |
| Journal Entry & Optional Timesheet | Create | |
Learning Aim | Get / Update / Search | |
| Off-the-job | Update | |
| Plan | Get / Search | |
Plan Template | Assign | |
| Register Sessions | Create / Get / Update / Add Attendee / Remove Attendee / Delete | |
| Review | Create / Get / Search | |
| Scorecard | Create | |
| Standard | Assign | |
| Timesheet | Get | |
| Unit | Assign | |
| Unit Summary | Get / Update / Search | |
| User | Create / Get / Update / Search / Archive / Unarchive / Delete | |
| Visit | Create / Update / Search | |
| Employers and Observers | Placement Assignment | Assign |
| Assessors | User | Archive / Unarchive / Delete |
Full Details
For complete documentation and technical specifications, click here.