You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi/clientapi.yaml
+3-5Lines changed: 3 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -71,11 +71,7 @@ paths:
71
71
summary: List Activity
72
72
security:
73
73
- basic_auth: []
74
-
description: >
75
-
The `from` field does not work as you would expect, since this endpoint is meant for pagination on the home page, Classcharts only returns a 50 points from the `to` field.
76
-
77
-
78
-
To get more points you will need to make use of the `last_id` field. Our [JavaScript Library](https://github.com/classchartsapi/classcharts-api-js) provides a `client.getFullActivity()` helper function to do this for you.
74
+
description: Lists up to 50 activity points
79
75
80
76
parameters:
81
77
- name: studentId
@@ -90,11 +86,13 @@ paths:
90
86
format: date
91
87
- name: to
92
88
in: query
89
+
description: This endpoint is meant for pagination so the response will not include up to this date (unless there is less than 50 points)
93
90
schema:
94
91
type: string
95
92
format: date
96
93
- name: last_id
97
94
in: query
95
+
description: This endpoint is meant for pagination so this field is used to start as a specific id onwards
0 commit comments