Scopes
Scopes permit your application to request a specific level of data from a ScholarPack school. When starting the authorisation flow you can use the following scopes. The scope description is shown to the user when they are on the authorisation screen at the beginning of the authorisation flow.
| Scope Name | Description |
|---|---|
| student:read |
Student Information Read
|
| contacts:first-party |
First-party Contacts Read
|
| contacts:third-party |
Third-party Contacts Read
|
| student-exclusion:read |
Student Exclusion Read
|
| student-register:read |
Student Registration Read
|
| student-register:write |
Student Registration Write
|
| student-photo:read |
Student Photo Read
|
| former-student-register:read |
Former-student Registration Read
|
| student-meal:read | Student Meal Read |
| student-assessment:read | Student Internal Assessment Read |
| statutory-assessment:read | Student Statutory Assessment Read |
| staff:read | Staff Information Read |
| staff-contract:read | Staff Contract Read |
| staff-register:read | Staff Register Read |
| staff-register:write | Staff Registration Write |
| staff-swipe:write | Staff Swipe Write |
| sen:read* | SEN Read |
| school-info:read | School Information Read |
| lac:read* | Looked-after Read |
* These scopes are not included by default. You will have to request these specifically when filling out the API Setup Request Form.