Current Service Paths
| Service path | Use Case | URL |
|---|---|---|
| GetStaffAssignmentsForStaff | Retrieve all the Staff Assignments (job positions) for a single staff | GET ... / StaffPersonals / / StaffAssignments |
| GetStaffAssignmentsForSchoolInfo | Retrieve all the Staff Assignments (job positions) for a single school/campus | GET ... / SchoolInfos / / StaffAssignments |
| GetStaffPersonalsForStaffAssignment | Retrieve all the Staff records for a single staff assignment (job position) | GET ... / StaffAssignments / / StaffPersonals |
| GetStaffPersonalsForStudent | Retrieve all the Staff records for a single student | GET ... / StudentPersonals / / StaffPersonals |
| GetStaffPersonalsForTeachingGroup | Retrieve all the Teachers for a single class | GET ... / TeachingGroups / / StaffPersonals |
| GetStaffPersonalsForSchoolInfo | Retrieve all the Teachers for a single school/campus | GET ... / SchoolInfos / / StaffPersonals |
| GetStudentContactPersonalForStudentEnrolment | Retrieve all the TeachingGroups (classes) for a single student | GET ... / StudentSchoolEnrollments / / StudentContactPersonals |
| GetStudentContactPersonalsForStudent | Retrieve all the Contacts for a single Student | GET ... / StudentPersonals / / StudentContactPersonals |
| GetStudentPersonalForStudentEnrollment | Retrieve all the StudentPersonals for a single Student Enrollment | GET ... / StudentSchoolEnrollments / / StudentPersonals |
| GetStudentPersonalsForStaff | Retrieve all the student details that a single staff member teaches | GET ... / StaffPersonals / / StudentPersonals |
| GetStudentPersonalsForStudentContact | Retrieve all the Students (& their details) for a single student contact (parent) | GET ... / StudentContactPersonals / / StudentPersonals |
| GetStudentPersonalsForTeachingGroup | Retrieve all the StudentPeronals (students) for a single subject class | GET ... / TeachingGroups / / StudentPersonals |
| GetStudentPersonalsForSchoolInfo | Retrieve all the StudentPeronals (students) for a single school/campus | GET ... / SchoolInfos / / StudentPersonals |
| GetTeachingGroupsForStaff | Retrieve all the TeachingGroups (classes) for a single staff | |
| GetTeachingGroupsForStudent | Retrieve all the TeachingGroups (classes) for a single student | GET ... / StudentPersonals / / TeachingGroups |
| GetTeachingGroupsForSchoolInfo | Retrieve all the TeachingGroups (classes) for a single school/campus | GET ... / StudentPersonals / / TeachingGroups |
| GetStudentAttendanceTimeListsForSchoolInfo | Retrieve all the AttendanceTimeLists for a single school/campus | GET ... / SchoolInfos/ / StudentAttendanceTimeLists |
| GetStudentContactRelationshipsForSchoolInfo | Retrieve all the Student contact Relationships (student contacts) for a single school/campus | GET ... / SchoolInfos / / StudentContactRelationships |
| GetStudentEnrollmentForSchoolInfo | Retrieve all the StudentSchoolEnrollment for a single school/campus | GET ... / SchoolInfos / / StudentSchoolEnrollments |
| GetStudentScoreJudgementAgainstStandardForSchoolInfo | Retrieve all the StudentScoreJudgementAgainstStandard for a single school/campus | GET ... / SchoolInfos / / StudentScoreJudgementAgainstStandards |
| GetTimeTableCellForSchoolInfo | Retrieve all the TimeTableCell for a single school/campus | GET ... / SchoolInfos / / TimeTableCells |
| GetTimeTableForSchoolInfo | Retrieve all the TimeTable/TimeTableDefinition for a single school/campus | GET ... / SchoolInfos / / TimeTableDefinitions |
Coming...
| Service path | Use Case | URL |
|---|---|---|
| GetStudentContactRelationshipsForStudent | Retrieve all the Student contact Relationships (student contacts) for a single student | GET ... / StudentPersonal / / StudentContactRelationships |
| GetStudentContactRelationshipsForStudentContact | Retrieve all the Student contact Relationships (student contacts) for a single student contact | GET ... / StudentContactPersonal / / StudentContactRelationships |
| GetStudentEnrollmentsForStudent | Retrieve all the Student Enrollments for a single student | GET ... / StudentPersonal / / StudentSchoolEnrollments |
SchoolInfo as Campus Sample
Following url is the format to retrieve all the StudentSchoolEnrollment objects that belong to that specific campus.
GET {School's SIF Base URL}/SchoolInfos//StudentSchoolEnrollments
Given that the main school id is F5E6B1B7-D80A-4940-8D1A-DEB76DBBDE58 and the school has at least on campus with the SIF ref id of E1289894-10D7-4073-B7F3-AC8B13E07C89 to retrieve all the objects that belong to that specific campus we can use
GET {School's SIF Object Provider Base URL}/SchoolInfos/E1289894-10D7-4073-B7F3-AC8B13E07C89/StudentSchoolEnrollments.
So we simply replace with the campus ref id.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article