Skip main menu

Courses

The following requests relate to getting information regarding the academy's courses via the Schoox Academy API. Note: All requests must be Authenticated. You can simulate a user's view by his/her Schoox ID.

Get a List of Courses

Returns a list of all courses with extended details.

GET /courses

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
userId User's ID you want to retrieve his/her course list view No Integer 3
search Search term No String Course A
status Course status. Available values "active", "deleted, "archived". Default is "active". No String archived
skills Get all courses related with this skills' ids No Array of integers [1,2,3]
start Starting Position No Integer 0
limit Number of courses to return per request, up to maximum of 100. Default to 100 No Integer 100
Example Request

https://api.schoox.com/v1/courses?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":3703886,"title":"Course 1","description":"Course 1\n","students":2,"lectures_count":1,"exams_count":1,"polls_count":0,"job_trainings_count":1,"events_count":0,"course_duration":0,"external_id":"347634","rating":0,"course_steps":[{"step_id":1997763,"step_type":"Lecture (wikipedia)","step_name":"API"},{"step_id":2744992,"step_type":"Exam","step_name":"Exam 1"},{"step_id":106082,"step_type":"On the Job Training","step_name":"On the Job Training 1"}],"url":"https:\/\/app.schoox.com\/3703886\/course-1","image":"https:\/\/app.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","level":"Introductory","language":"English","equivalents":[],"completedAsEquivalent":false,"instructor":{"id":360525660,"firstname":"Dev","preferred_name":null,"lastname":"Team","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","profile_url":"https:\/\/app.schoox.com\/user\/360525660\/"},"categories":[{"id":-1,"name":"Without Category"}],"tags":[""],"price":0,"academy_id":226581108,"priority":0,"time_published":"2021-12-01T09:08:53+00:00","scope":"employees"}]

Get a List of a User's Courses

Returns a list of a user's enrolled & created courses with extended details by his/her Schoox ID.

GET /courses/user/:userid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
external_id Sets whether the userId given is the external_id of the User.
By default, the value is "false"		 No String true
role Role of User.
Available values are: student, professor & dropped_out		 No String student
status Course status.
Available values are: active & archived		 No String active
search Search course by term No String Schoox
enrolled Courses user is enrolled to
Available values are: true & false		 No String true
category_id Course Category ID No Integer 0
language Filter by language.
Available values are: aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zut.		 No String es
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/courses/user/2099521483?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":3703886,"title":"Course 1","description":"Course 1\n","students":2,"lectures_count":1,"exams_count":1,"polls_count":0,"job_trainings_count":1,"events_count":0,"course_duration":0,"external_id":"347634","rating":0,"course_steps":[{"step_id":1997763,"step_type":"Lecture (wikipedia)","step_name":"API"},{"step_id":2744992,"step_type":"Exam","step_name":"Exam 1"},{"step_id":106082,"step_type":"On the Job Training","step_name":"On the Job Training 1"}],"url":"https:\/\/app.schoox.com\/3703886\/course-1","image":"https:\/\/app.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","level":"Introductory","language":"English","equivalents":[],"completedAsEquivalent":false,"instructor":{"id":360525660,"firstname":"Dev","preferred_name":null,"lastname":"Team","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","profile_url":"https:\/\/app.schoox.com\/user\/360525660\/"},"categories":[{"id":-1,"name":"Without Category"}],"tags":[""],"price":0,"academy_id":226581108,"priority":0,"role":"Student","progress":0,"time":"0:00:00","certificates":[{"id":188154098,"ver_code":"b643417","total_time":"0:00:00","time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/app.schoox.com\/c188154098?ver_code=b643417"}],"time_published":"2021-12-01T09:08:53+00:00","scope":"employees"}]

Get a List of a User's Course Categories

Returns a list of a user's course categories by his/her Schoox ID.

GET /courses/categories?userId=:userid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
userId User's ID you want to retrieve his/her course details No Integer 3
external_id Sets whether the userId given is the external_id of the User.
By default, the value is "false"		 No String true
role Role of User.
Available values are: student & professor		 No String student
Example Request

https://api.schoox.com/v1/courses/categories?userId=2099521483&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":-1,"name":"Without Category"}]

Get Details for a Course

Returns extended details of a specific course. A user's progress percentage, time spent and enrollment date can be retrieved by his/her Schoox ID.

GET /courses/:courseid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
userId User's ID you want to retrieve his/her course details No Integer 3
status Course status. Available values "active", "deleted, "archived". Default is "active". No String archived
Example Request

https://api.schoox.com/v1/courses/3703886?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
{"id":3703886,"external_id":"347634","title":"Course 1","description":"Course 1\n","image":"https:\/\/app.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","url":"https:\/\/app.schoox.com\/3703886\/course-1","language":"English","level":"Introductory","status":"Active","compliance":false,"time_created":"2021-12-01T08:19:50+00:00","course_duration":0,"course_steps":[{"step_id":1997763,"step_type":"Lecture (wikipedia)","step_name":"API"},{"step_id":2744992,"step_type":"Exam","step_name":"Exam 1"},{"step_id":106082,"step_type":"On the Job Training","step_name":"On the Job Training 1"}],"time_published":"2021-12-01T09:08:53+00:00","scope":["employees"],"public_category":{"id":227,"name":"Miscellaneous"},"academy_categories":[{"id":-1,"name":"Without Category","parentId":null}],"instructor":{"id":360525660,"firstname":"Dev","preferred_name":null,"lastname":"Team","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/user\/360525660\/"},"academy_id":226581108,"students":2,"ratings":0,"rating":0,"reviews":0,"equivalents":[],"tags":[""],"price":0}
Response Object for External Course
Show All 
{
   "id":3703886,
   "external_id":"347634",
   "title":"External Course ",
   "description":"External Course",
   "image":"https://app.schoox.com/theme/schoox/assets/course/images/Course_default_image.png",
   "url":"https://app.schoox.com/3703886/ExternalCourse",
   "language":"English",
   "level":"Introductory",
   "status":"Active",
   "compliance":false,
   "time_created":"2021-12-01T08:19:50+00:00",
   "course_duration":0,
   "course_steps":[
      {
         "step_id":1997763,
         "step_type":"Lecture (wikipedia)",
         "step_name":"API"
      },
      {
         "step_id":2744992,
         "step_type":"Exam",
         "step_name":"Exam 1"
      },
      {
         "step_id":106082,
         "step_type":"On the Job Training",
         "step_name":"On the Job Training 1"
      }
   ],
   "time_published":"2021-12-01T09:08:53+00:00",
   "scope":[
      "employees"
   ],
   "public_category":{
      "id":227,
      "name":"Miscellaneous"
   },
   "academy_category":{
      "id":-1,
      "name":"Without Category"
   },
   "instructor":{
      "id":360525660,
      "firstname":"Dev",
      "preferred_name":null,
      "lastname":"Team",
      "image":"https://app.schoox.com/user/images/no-user-image_small.gif",
      "url":"https://app.schoox.com/user/360525660/"
   }
}

Get a List of Enrolled Users in a Course

Returns a list of a course's enrolled users with each user's enrolled date, progress percentage and time spent.

GET /courses/:courseid/students

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
start Starting Position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
onlyCompleted Return only users that have completed the course No Text true
Example Request

https://api.schoox.com/v1/courses/3703886/students?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":473159548,"firstname":"Frank","preferred_name":"test","lastname":"Doe","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/user\/473159548\/","time_enrolled":"2022-08-26T13:03:36+00:00","progress":50,"time":"0:00:11","certificates":[]},{"id":2099521483,"firstname":"John","preferred_name":null,"lastname":"Doe","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/user\/2099521483\/","time_enrolled":"2021-12-01T08:26:38+00:00","progress":0,"time":"0:00:00","certificates":[{"id":188154098,"ver_code":"b643417","total_time":"0:00:00","time_certified":"2022-08-26T13:03:49+00:00","url":"https:\/\/app.schoox.com\/c188154098?ver_code=b643417"}]}]

Get a List of Lectures in a Course

Returns a list of a course's lectures. You can retrieve a user's progress percentage, time spent and number of views for each lecture by his/her Schoox ID.

GET /courses/:courseid/lectures

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
userId User's ID you want to retrieve his/her course details No Integer 3
Example Request

https://api.schoox.com/v1/courses/3703886/lectures?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":1997763,"name":"API","description":"","image":"http:\/\/upload.wikimedia.org\/wikipedia\/commons\/thumb\/4\/41\/Database_management_system_diagram_from_1978_workshop.png\/220px-Database_management_system_diagram_from_1978_workshop.png","url":"\/course\/website\/view.php?courseid=3703886&lp_id=1997763&callback=?","demo":false,"visible":true,"type":"website"}]

Get a List of Exams in a Course

Returns a list of a course's exams. You can retrieve the date of his or her last attempt, total score and points as well as the passing or failure status for each exam by his/her Schoox ID.

GET /courses/:courseid/exams

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
userId User's ID you want to retrieve his/her course details No Integer 3
Example Request

https://api.schoox.com/v1/courses/3703886/exams?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"id":2744992,"name":"Exam 1","description":null,"image":"https:\/\/app.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","url":"https:\/\/app.schoox.com\/exams\/exam.php?eid=2744992","type":"Try and Learn","instructions":null,"time_limit":null,"lecture_id":0,"time_added":"2021-12-01T08:20:26+00:00","published":true,"disabled":false,"creator":{"id":1520241641,"firstname":"Security","preferred_name":null,"lastname":"User","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif"}}]

Get a List of Coupons in a Course

Returns a list of generated coupons for a specific course.

GET /courses/:courseid/coupons

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/courses/46776/coupons?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Get a List of Enrolled Users in a Course Coupon

Returns a list of a course's enrolled users for a specific coupon with each user's enrolled date, progress percentage and time spent.

GET /courses/:courseid/coupons/:couponid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/courses/46776/coupons/5131?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Get a List of all Course Invitations

You can either assign a course to a user or invite the user to enroll in a course. If you assign the course the user will automatically be enrolled in and the course in considered to be required. If you send an invitation the user will have the option to enroll optionally. This request returns a list of all invitations that have been sent for a particular course.

GET /courses/:courseid/invitations

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/courses/3703886/invitations?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
[{"user":{"id":473159548,"firstname":"Frank","preferred_name":"test","lastname":"Doe","image":"https:\/\/app.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/app.schoox.com\/user\/473159548\/"},"time_invited":"2022-01-26T14:54:47+00:00","time_enrolled":"2022-08-26T13:03:36+00:00"}]

Get a List of skills related to course

Returns a list of all skills related with a course.

GET /courses/:courseId/skills

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/courses/3703886/skills?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All 
{"skills":[{"courseId":"3703886","skillId":135035,"systemSkill":false,"name":"General Communication Skill","type":{"id":33824,"title":"Communication Skills"},"levels":[],"industry":null,"tier":null,"category":null}],"professionLevels":[]}

Course complete by admin

A Course will be marked as "completed by Admin". The user's course-progress will be updated and the course completion will trigger several actions, such as: Award Course Certificate, Award Badge, Award Credits, Update user's Learning path-progress (if needed), Award Learning path Certificate (if needed). You can send up to 10 user ids per call.

PUT courses/:courseid/completeByAdmin

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
externalIds Defines if the users ids are external or not Yes String false
completedAt Defines the date when the Course is marked as completed by the Admin, in YY-MM-DD date format. No Date 2020-11-25
Request Object Schema
Name Description Required Type Sample Value
userIds Array of user ids Yes Array [123, 456, 789]
certificatePdfBase64 Α custom certificate will be given for the completions made by this call if the course certificate setting is enabled. The certificate needs to be added to the call as a PDF, encoded in base64, and up to 5MB. No String JVBERi0NC...g4CiUlRU9GCg==
Example Request

https://api.schoox.com/v1/courses/46776/completeByAdmin?externalIds=false&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All 
{"users":[123,456,789],"certificatePdfBase64":"JVBERi0NC...g4CiUlRU9GCg=="}
Response Object
Show All 
[{"user":{"id":123,"status":"success"}},{"user":{"id":456,"status":"success"}},{"user":{"id":789,"status":"failed"}}]

Issue custom certificate

Issue a custom certificate for a specific course for a user.

PUT courses/:courseid/issueCustomCertificate

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Request Object Schema
Name Description Required Type Sample Value
certificatePdfBase64 Α custom certificate will be given for the completions made by this call if the course certificate setting is enabled. The certificate needs to be added to the call as a PDF, encoded in base64, and up to 5MB. Yes String JVBERi0NC...g4CiUlRU9GCg==
Example Request

https://api.schoox.com/v1/courses/46776/issueCustomCertificate?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All 
{"users":[123],"certificatePdfBase64":"JVBERi0NC...iXi48\/TDQoNCjEgv"}
Response Object
Show All 
[{"user":{"id":123,"status":"success"}}]

Course oblige to retake

Oblige users to retake a course. You can send up to 10 user ids per call.

PUT courses/:courseId/obligeToRetake

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/courses/37/obligeToRetake?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All 
{"users":[123,456,789],"due_date":"01-10-2024","message":"Please complete this course"}
Response Object
Show All 
[{"user":{"id":123,"status":"success"}},{"user":{"id":456,"status":"success"}},{"user":{"id":789,"status":"failed"}}]