james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 19:59:37 +00:00
Code Activity

Added parent homework method

Browse source
This commit is contained in:
Kevin 2026-05-06 21:04:16 +01:00
parent 80fde1386b
commit 2050b51f65
3 changed files with 155 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -353,6 +353,38 @@ Selects a pupil to make subsequent requests for.
await client.selectPupil(123);
```
## `.getHomeworksForPupil`
Gets homework for a specific pupil ID without permanently changing the selected pupil.
```typescript
const homework = await client.getHomeworksForPupil(123, {
from: "2026-05-01",
to: "2026-05-31",
displayDate: "due_date",
});
console.log(homework);
```
## `.getHomeworksForEachPupil`
Gets homework for each pupil ID. If no IDs are passed, it fetches for all attached pupils.
```typescript
const allHomework = await client.getHomeworksForEachPupil({
from: "2026-05-01",
to: "2026-05-31",
});
const selectedHomework = await client.getHomeworksForEachPupil(
{ displayDate: "issue_date" },
[123, 456],
);
console.log(allHomework[123]);
console.log(selectedHomework[456]);
```
## `.changePassword`
Changes the parent's password.