Skip to content

Improve JSON API docs by using endpoint names as headers and updating example responses - #10

Open
KTibow wants to merge 1 commit into
StudentVue:masterfrom
KTibow:method-per-section
Open

KTibow wants to merge 1 commit into
StudentVue:masterfrom
KTibow:method-per-section

Conversation

@KTibow

@KTibow KTibow commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

See diff. Main change is reorganizing based on the endpoint names and extending the example responses based on real data now that the school year has started.

Reorganize the Examples section into one header per JSON-API method
(in catalog order), each with its request and a fuller, anonymized
in-session response: GetChildListData (district config + childrenList),
StudentClassList (both loadAllTerms modes + todayScheduleInfoData),
GetStudentClasesForGivenDay(-Response), GetStudentClassTime, Gradebook,
GetStudentAttendanceList, GetStudentPastAttendanceData, GetStudentInfoData,
GetCalendarData, GetCalendarAssignmentDetails, GetStudentDocuments,
GetStudentDocumentContent, GetStudentHWNotes, GetPXPContentMessage,
GetUserDefinedModule, GetSchoolInformationData, GetContentMyAccountData,
GetAcknowledgementsData, GetHallPassSetup, GetHealthData,
GetStudentDisciplineData/FeeData, GetSynergyMailUnreadCount,
GetSynergyMailGetConversations, TestSystemCall. Corrects the child-list
payload key (childrenList, not childInfos), documents extra error
envelopes, and upgrades catalog entries verified live (o -> check).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant