alaress / schoolbox-api-docs Goto Github PK

In some apps, it may be necessary to retrieve a list of articles instead of just their identifiers. This feature is particularly useful for applications that enable users to save articles for later. However, it would be great to establish an efficient method for retrieving these articles without iterating through all the identifiers.

The example reponse at https://api.schoolbox.com.au/#get-/api/assessment/-id- shows participants being returned as an object.
It should be an array, as per schema at https://github.com/alaress/schoolbox-api-docs/blob/develop/openapi/components/schemas/assessment-item.yaml

Hello all.

In order to get all feedback for a particular student, I need to retreive every single assessment.
I have a school of 400 students, and we're currently at 9000 assessments that have a due date in 2023.
9000 api calls to get the marks for a student??? It seems like this would be a common use case for the api.
I could cut down my calls by a factor of 20 if I could get assessments per student/learner

Documentation

https://api.schoolbox.com.au/#get-/user/token

Documented Response Schema

{
  "token": "<REDACTED>"
}

Actual Response (Non-QR)

{
  "token": "<REDACTED>",
  "createdAt": null,
  "expiry": null,
  "createdBy": null,
  "jwtId": null,
  "showExisting": false
}

Hi there,

Only a POST request appears to work for the following endpoint; It's documented as requiring the GET method.

https://api.schoolbox.com.au/#operation/commsNewsSaveForLater.postAdd

The groups schema for the /api/user/{id} endpoint stipulates that the groups property value is a dictionary with the group’s Id as the key and group obj as the value. This is true for the most part alas, not when the user is not enrolled in any groups.

If the user is enrolled in groups, the response looks like this:

{
	“groups”:  {
		“5213”: {...}
	}
}

If the user is not enrolled in any groups, it looks like:

{
	“groups”:  []
}

Hey

The changes brought forward in this pull provision non-superusers to access the userGet endpoint. After giving this a shot, it was evident that the schema inaccurately depicts the response from the API.

The schema depicts the groups property as an array of groups. Rather, the API returns a dictionary with the key being the group id and the value being the userGroupMembership-read item.

Although the API docs are inaccurate, The API itself should be updated to conform to the defined schema as it is more in line with other endpoints and works better with strictly typed languages.