BQuSAMS API Documentation

Index

Description

  Main
  /country [ GET ]
  /lecturers [ GET ]
  /students [ GET ]
  /course [ GET ]
  /faculty [ GET ]
  /students_log [ GET ]
  /module [ GET ]

  Module
  /module/:module_id/registered_students [ GET ]
  /module/:module_id/timetable [ GET ]

  Course
  /course/:course_id [ GET ]
  /course/:course_id/modules [ GET ]

  Timetable
  /timetable/:timetable_id [ GET ]
  /timetable/:timetable_id/present_students [ GET ]


GET

Returns information of the countries.

country_id: Unique ID for country
country_name: name of the country

available response representations: application/json

[{"country_id":"1","country_name":"Afghanistan"},{"country_id":"14","country_name":"Australia"},{"country_id":"15","country_name":"Austria"},{"country_id":"16","country_name":"Azerbaijan"},{"country_id":"17","country_name":"Bahamas"},{"country_id":"18","country_name":"Bahrain"},{"country_id":"19","country_name":"Bangladesh"},{"country_id":"20","country_name":"Barbados"},{"country_id":"21","country_name":"Belarus"}]

GET

Returns information of the lecturers.

lecture_id: Unique ID for the lecturer
lecture_name: name of the lecturer
lecture_description: Description of the lecturer

available response representations:
application/json

[{"lecture_id":"1","lecture_name":"Dr. Gary Pritchard","lecture_description":null},{"lecture_id":"2","lecture_name":"Angela Biggins","lecture_description":null},{"lecture_id":"3","lecture_name":"Kate Cheal","lecture_description":null},{"lecture_id":"4","lecture_name":"Fran Bentley","lecture_description":null},{"lecture_id":"5","lecture_name":"Some one","lecture_description":null},{"lecture_id":"6","lecture_name":"Susie Forbes","lecture_description":null}]

GET

Returns information of the students.

available response representations:

student_sid: Unique ID for the student
student_id: ID for the student . THis is the mapping ID with other tables.
student_fingerprint: Fingerprint ID ( Foreign key)
student_lastname: Student Last name
student_ukbase: ( Foreign key)
student_type_of_visa: Student VISA type
student_email: Student Email
student_phone_number: Student phone no.
student_address: Student address
student_faculty_id: Faculty id student belongs to ( Foreign key)
student_isFPupdated: ( Foreign key)
student_street2: Student street name
student_town: Student Town
student_country: Student country
student_postcode: Student postcode
student_c_id: ( Foreign key)

application/json

[{"student_sid":"1","student_id":"1","student_fingerprint":"1","student_lastname":"", "student_ukbase":"N","student_type_of_visa":"2","student_email":"dea.banares@yahoo.com", "student_phone_number":"7584311682","student_address":"NA","student_faculty_id":"1", "student_isFPupdated":"0","student_street2":null,"student_town":null, "student_country":null,"student_postcode":null,"student_c_id":"5"}, {"student_sid":"2","student_id":"2","student_fingerprint":"2","student_lastname":"", "student_ukbase":"N","student_type_of_visa":"2","student_email":"tiana.barnard@gmail.com", "student_phone_number":"7502407788","student_address":"NA","student_faculty_id":"1", "student_isFPupdated":"0","student_street2":null,"student_town":null, "student_country":null,"student_postcode":null,"student_c_id":"6"}]

GET

Returns information of the courses.

course_cid: Unique ID for the course.
course_name: Name of the course.
course_name_c_id: ( Foreign key)

available response representations:
application/json

[{"course_cid":"1","course_name":"Vogue Fashion Certificate - April 13","course_name_c_id":"3"}, {"course_cid":"149","course_name":"Canvas Student Orientation","course_name_c_id":"1"}, {"course_cid":"150","course_name":"Canvas Instructor Orientation","course_name_c_id":"2"}, {"course_cid":"151","course_name":"Vogue Fashion Certificate - July 13","course_name_c_id":"66"}]

GET

Returns information of the faculties.

faculty_id: Unique ID for the faculty.
faculty_name: Name of the faculty.

available response representations:
application/json

[{"faculty_id":"1","faculty_name":"Fashion College"}]

GET

Returns information of the students logs.

student_log_lid: Unique ID for student attendance.
student_log_sid: ID of the student.
student_log_module_id: ID of the module.
student_log_classroom_id: ID of the class room.
student_log_log_time: Log in time.
student_log_log_date: Log in date.
student_log_timetable_id: Time table ID.
student_log_fingerprint: Fingerprint device ID.

available response representations:
application/json

[{"student_log_lid":"4555","student_log_sid":"27","student_log_module_id":"22", "student_log_classroom_id":"0","student_log_log_time":"13:56:00", "student_log_log_date":"2013-04-29","student_log_timetable_id":"22", "student_log_fingerprint":"0"},{"student_log_lid":"3940","student_log_sid":"6", "student_log_module_id":"1","student_log_classroom_id":"0", "student_log_log_time":"13:56:00","student_log_log_date":"2013-04-15", "student_log_timetable_id":"1","student_log_fingerprint":"0"}]

GET

Returns information of the modules.

module_id: Unique ID for module.
module_name: Name of the module.

available response representations:
application/json

[{"module_id":"1","module_name":"test"},{"module_id":"3","module_name":"test2"}]

GET

Returns information of the timetables which has joined with a particular modules.

student_fingerprint: Unique ID for student from fingerprint device.
student_lastname: Last name of the student.
student_ukbase:( Foreign key)
student_type_of_visa: Student VISA type.
student_email: Student Email.
student_phone_number: Student phone no..
student_address: Student Address.
student_reg_module_id: Student registered module ID.
student_sid: Name of the module.

available response representations:
application/json

[{"student_fingerprint":"1","student_lastname":"","student_ukbase":"N","student_type_of_visa":"2", "student_email":"dea.banares@yahoo.com","student_phone_number":"7584311682","student_address":"NA", "student_reg_module_id":"1","student_sid":"1"},{"student_fingerprint":"2","student_lastname":"", "student_ukbase":"N","student_type_of_visa":"2","student_email":"tiana.barnard@gmail.com", "student_phone_number":"7502407788","student_address":"NA","student_reg_module_id":"8","student_sid":"2"}]

GET

Returns information of the timetables which has joined with a particular module.

timetable_id: Unique ID for timetable.
timetable_date: Date of the timetable.
timetable_start_time: Start time of the timetable.
timetable_end_time: End time of the timetable.

available response representations:
application/json

[{"timetable_id":"1","timetable_date":"2013-04-15","timetable_start_time":"14:00:00","timetable_end_time":"16:30:00"}]

GET

Returns information about the particular courses.

course_id: Unique ID for course.
course_course_name: Name of the course.
course_canvas_id: Canvas API ID of the course.

available response representations:
application/json

[{"course_id":"1","course_course_name":"Vogue Fashion Certificate - April 13","course_canvas_id":"3"}]

GET

Returns information of the modules which has joined with a particular courses.

module_id: Unique ID of the module.
module_lecture_name: Lecturer of the module.
module_faculty_name: Faculty of the module.
module_lecturer_id: Lecturer ID ( foreign key ).
module_faculty_id: Faculty ID( foreign key )
module_qualification_id: Qualification ID ( foreign key )
module_qualification_name: Qualification Name ( foreign key )

available response representations:
application/json

[{"module_id":"1","module_lecture_name":"Dr. Gary Pritchard","module_faculty_name":"Fashion College", "module_lecturer_id":"1","module_faculty_id":"1","module_qualification_id":"1","module_qualification_name":"Level 4"}, {"module_id":"3","module_lecture_name":"Angela Biggins","module_faculty_name":"Fashion College", "module_lecturer_id":"2","module_faculty_id":"1","module_qualification_id":"1","module_qualification_name":"Level 4"}]

GET

Returns information about the particular timetable.

timetable_id: Unique ID for timetable.
start_time: Start time of timetable unit.
end_time: End time of timetable unit.
date: Date of timetable unit.

available response representations:
application/json

[{"timetable_id":"1","start_time":"14:00:00","end_time":"16:30:00","date":"2013-04-15"}]

GET

Returns information about the student's present in a particular timetable ID.

timetable_log_time: Timetable added time.
timetable_log_date: Timetable added date.
timetable_module_name: Parent module name .
timetable_student_id: Student ID ( Foreign key ).
timetable_student_fingerprint: Fingerprint device ID ( Foreign key ).

available response representations:
application/json

[{"timetable_log_time":"13:56:00","timetable_log_date":"2013-04-15","timetable_module_name":"Student Induction", "timetable_student_id":"6","timetable_student_fingerprint":"0"},{"timetable_log_time":"13:56:00", "timetable_log_date":"2013-04-15","timetable_module_name":"Student Induction","timetable_student_id":"20", "timetable_student_fingerprint":"0"}]

Please contact API Manager for Updates