Module: XodClient::DataEndpoints

Included in:
Connection
Defined in:
lib/xod_client/concerns/data_endpoints.rb

Instance Method Summary collapse

Instance Method Details

#groups(**params) ⇒ Object

params: options, id, type, code, COMMON_PARAMS options: includeStaffMembers

includeStudentMembers
includeMembersIds
includeMembersIdaasIds
includeMembersXIDs
includeSubjects
includeGroupTypes

type: YearGrp, HouseGrp, RegGrp, TeachingGrp



14
15
16
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 14

def groups(**params)
  endpoint('school.groups', params)
end

#health(**params) ⇒ Object 



18
19
20
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 18

def health(**params)
  endpoint('school.health', params)
end

#school_info(**params) ⇒ Object

params: COMMON_PARAMS



23
24
25
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 23

def school_info(**params)
  endpoint('school.schoolinfo', params)
end

#staff(**params) ⇒ Object

params: id, staff_status, COMMON_PARAMS options: includePhotos

includeGroupIds
includeGroupIdaasIds
includeGroupXIDs
teachersOnly
includeFuture
includePrevious

staff_status: Current, Future, Previous



36
37
38
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 36

def staff(**params)
  endpoint('school.staff', params)
end

#students(**params) ⇒ Object

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



55
56
57
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 55

def students(**params)
  endpoint('school.students', params)
end

#timetable(**params) ⇒ Object

params: options, date_from, date_to, COMMON_PARAMS options: includeLessons

includeLessonStaff
includeLessonRooms



63
64
65
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 63

def timetable(**params)
  endpoint('school.timetable', params)
end

#timetable_model(**params) ⇒ Object

params: COMMON_PARAMS



68
69
70
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 68

def timetable_model(**params)
  endpoint('school.timetablemodel', params)
end

#timetable_structure(**params) ⇒ Object

params: date_from, date_to, COMMON_PARAMS



73
74
75
 
# File 'lib/xod_client/concerns/data_endpoints.rb', line 73

def timetable_structure(**params)
  endpoint('school.timetablestructure', params)
end