Get the full school structure tree

Returns nodes and edges for an academic year, optionally including students, parents, and staff members.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

year_idintegerRequired

Request

This endpoint expects an object.
studentsbooleanOptional
parentsbooleanOptional
staffbooleanOptional

Response

The full structure tree was returned.
statusstringOptional
messagestringOptional
dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error