Curriculums

The following requests relate to getting information regarding the academy's curriculums 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 Curriculums

Returns a list of all curriculums with extended details.

GET /curriculums

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
userId User's ID you want to retrieve his/her curriculum list view No Integer 3
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/curriculums?apikey=schoox&acadId=386

Response Object
Show All
[{"id":1308,"title":"Innovalearn Curriculum","description":"","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1308","private":false,"courses":2},{"id":1196,"title":"Red Book Connect SchooX Courses","description":"10 great courses you receive when you purchase SchooX","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/1196\/aSllN50QQkeKAmEXjeAl_Screen Shot 2014-10-14 at 5.18.36 PM.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1196","private":true,"courses":19},{"id":250,"title":"Curriculum for new employees","description":"This curriculum is to introduce new employee to .... ","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=250","private":false,"courses":3},{"id":39,"title":"Wine Curriculum","description":"Everything about Wine","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/39\/d67d8ab4f4c10bf22aa353e27879133c.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=39","private":false,"courses":3},{"id":38,"title":"Customer Service","description":"A set of courses on how to serve clients. ","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/38\/a5771bce93e200c36f7cd9dfd0e5deaa.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=38","private":false,"courses":3},{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=37","private":false,"courses":2}]

Get a List of a User's Curriculums

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

GET /curriculums

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
userId User's ID you want to retrieve his/her curriculum list view No Integer 3
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/curriculums?userId=14&apikey=schoox&acadId=386

Response Object
Show All
[{"id":1308,"title":"Innovalearn Curriculum","description":"","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1308","private":false,"courses":2,"progress":0,"time_spent":"0:00:00"},{"id":1196,"title":"Red Book Connect SchooX Courses","description":"10 great courses you receive when you purchase SchooX","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/1196\/aSllN50QQkeKAmEXjeAl_Screen Shot 2014-10-14 at 5.18.36 PM.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=1196","private":true,"courses":19,"progress":0,"time_spent":"0:00:00"},{"id":250,"title":"Curriculum for new employees","description":"This curriculum is to introduce new employee to .... ","image":"\/\/static-cdn.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=250","private":false,"courses":3,"progress":0,"time_spent":"0:00:00"},{"id":39,"title":"Wine Curriculum","description":"Everything about Wine","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/39\/d67d8ab4f4c10bf22aa353e27879133c.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=39","private":false,"courses":3,"progress":0,"time_spent":"0:32:22"},{"id":38,"title":"Customer Service","description":"A set of courses on how to serve clients. ","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/38\/a5771bce93e200c36f7cd9dfd0e5deaa.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=38","private":false,"courses":3,"progress":0,"time_spent":"0:00:00"},{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=37","private":false,"courses":2,"progress":0,"time_spent":"0:32:15"}]

Get Details for a Curriculum

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

GET /curriculum/:curriculum

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
Example Request

https://api.schoox.com/v1/curriculums/37?apikey=schoox&acadId=386

Response Object
Show All
{"id":37,"title":"Great Food Intro Curriculum","description":"This is for new employees to get a comprehensive inside about the products and the business philosophy of Great Food.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/curricula\/37\/a5bfc9e07964f8dddeb95fc584cd965d.jpg","url":"https:\/\/www.schoox.com\/course\/programs\/index.php?id=37","private":false,"enrolled":true,"courses":[{"id":11657,"title":"How to serve a table","description":"This course is a set of video lectures with examples and best practices on how to serve a table and take orders. ","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11657\/1369906178531902169.jpg","url":"https:\/\/www.schoox.com\/11657\/how-to-serve-a-table","lectures_num":11,"exams_num":2,"materials_num":0},{"id":11673,"title":"Wine 101","description":"This courses is all about wine. If you are new to wine drinking and are looking for some basic, overall wine education, you've come to the right place. And if you've been enjoying wine for some time and are looking for some specific pieces of wine information you are missing, you\u2019ve also come to the right place.","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-320-190\/courses\/11673\/YhkSx78JTmuDZGsAp9To_wine101.jpg","url":"https:\/\/www.schoox.com\/11673\/wine-101?coupon=graecus","lectures_num":6,"exams_num":0,"materials_num":0}]}