Best Practices
Date Range Request Blocks
When making requests for data with DateTo and DateFrom parameters, choose standard ranges to ensure data collection efficiency.
Key Endpoints to Consider
These endpoints especially benefit from this approach:
- school.behaviourfordaterange
- school.achievementfordaterange
- school.timetable
- school.timetableforstaff
- school.timetableforstudent
- school.timetablestructure
Additional Note: Timetable endpoints fetch 1 week behind and 2 weeks ahead without passing any dates, by default. Consider if you need to specify date parameters or if the default range is sufficient for your use cases.
For example, requesting behaviour in month blocks:
https://xporter.groupcall.com/api/v1/School/3281102/BehaviourForDateRange/?DateFrom=2022-09-01&DateTo=2022-09-30&page=1&pageSize=25&httpstatuscodes=true
Monthly Blocks:
| Block | DateFrom | DateTo |
|---|---|---|
| Block 1 | 2022-09-01 | 2022-09-30 |
| Block 2 | 2022-10-01 | 2022-10-31 |
| Block 3 | 2022-11-01 | 2022-11-30 |
For some datasets, a month may be too large. Here, break into 2 week blocks:
2 Week Blocks:
| Block | DateFrom | DateTo |
|---|---|---|
| Block 1 | 2022-09-01 | 2022-09-14 |
| Block 2 | 2022-09-15 | 2022-09-30 |
| Block 3 | 2022-10-01 | 2022-10-14 |
| Block 4 | 2022-10-15 | 2022-10-31 |
| Block 5 | 2022-11-01 | 2022-11-14 |
| Block 6 | 2022-11-15 | 2022-11-30 |
Important
This approach will ensure all data is collected, and keep requests to the API and the school MIS to a minimum