module XodClient::DataEndpoints
Public Instance Methods
groups(**params)
click to toggle source
params: options, id, type, code, COMMON_PARAMS options: includeStaffMembers
includeStudentMembers includeMembersIds includeMembersIdaasIds includeMembersXIDs includeSubjects includeGroupTypes
type: YearGrp, HouseGrp, RegGrp, TeachingGrp
# File lib/xod_client/concerns/data_endpoints.rb, line 14 def groups(**params) endpoint('school.groups', params) end
health(**params)
click to toggle source
# File lib/xod_client/concerns/data_endpoints.rb, line 18 def health(**params) endpoint('school.health', params) end
school_info(**params)
click to toggle source
params: COMMON_PARAMS
# File lib/xod_client/concerns/data_endpoints.rb, line 23 def school_info(**params) endpoint('school.schoolinfo', params) end
staff(**params)
click to toggle source
params: id, staff_status, COMMON_PARAMS options: includePhotos
includeGroupIds includeGroupIdaasIds includeGroupXIDs teachersOnly includeFuture includePrevious
staff_status: Current, Future, Previous
# File lib/xod_client/concerns/data_endpoints.rb, line 36 def staff(**params) endpoint('school.staff', params) end
students(**params)
click to toggle source
params: options, id, year_group_id, student_status, onlygetDBStatus, COMMON_PARAMS options: includePhotos
includeGroupIds includeGroupIdaasIds includeGroupXIDs includeParentIdaasIds includeParentXIDs includeAttStats includeAttMarkString includeSiblingsList includeSiblingsResultset includeLeavers includePreAdmissions includeGuests includeSubsidiary
# File lib/xod_client/concerns/data_endpoints.rb, line 55 def students(**params) endpoint('school.students', params) end
timetable(**params)
click to toggle source
params: options, date_from, date_to, COMMON_PARAMS options: includeLessons
includeLessonStaff includeLessonRooms
# File lib/xod_client/concerns/data_endpoints.rb, line 63 def timetable(**params) endpoint('school.timetable', params) end
timetable_model(**params)
click to toggle source
params: COMMON_PARAMS
# File lib/xod_client/concerns/data_endpoints.rb, line 68 def timetable_model(**params) endpoint('school.timetablemodel', params) end
timetable_structure(**params)
click to toggle source
params: date_from, date_to, COMMON_PARAMS
# File lib/xod_client/concerns/data_endpoints.rb, line 73 def timetable_structure(**params) endpoint('school.timetablestructure', params) end