API Documentation
Training Dashboard- Training Dashboard
- List of Users
- List of a User's Courses
- List of a User's Curriculums
- List of a User's Exams
- List of Courses
- List of Enrolled Users in a Course
- Course Progress for a User
- List of Curriculums
- List of Enrolled Users in a Curriculum
- Curriculum Progress for a User
- List of Exams
- List of Enrolled Users in an Exam
- Courses
- Courses
- List of Courses
- List of a User's Courses
- List of a User's Course Categories
- Details for a Course
- List of Enrolled Users in a Course
- List of Lectures in a Course
- List of Exams in a Course
- List of Coupons in a Course
- List of Enrolled Users in a Course Coupon
- List of all Course Invitations
- List of skills related to course
- Course complete by admin
- Exams
- Events
- Curriculums
- Users
- Users
- List of Users
- Details of a User
- List User's Badges
- Create & Add a User
- Bulk Create & Add Users
- Invite a User
- Bulk Invite Users
- Edit a User
- Remove a User
- Reactivate a User
- Add a New Job
- Bulk New Jobs
- Edit a Job
- Delete a Job
- List Jobs
- Update User's Roles
- Update User's Jobs
- Add Units to a User
- Remove Unit from a User
- Add Above Units to a User
- Remove Above Unit from a User
- Add a New Type
- Bulk New Types
- Edit a Type
- Delete a Type
- List Types
- Add a New Above Unit
- Bulk New Above Units
- Edit an Above Unit
- Delete an Above Unit
- List Above Units
- Add a New Unit
- Bulk New Units
- Edit a Unit
- Delete a Unit
- List Units
- Archive a Unit
- Unarchive a Unit
- Delete an Archived Unit
- List Archived Units
- Assign Courses
- Unassign Courses
- Assign Curricula
- Unassign Curricula
- Add/Edit lecture progress for a user
- Check whether users are registered in a future Event
- Metrics
- Metrics
- List of Metrics
- Add Metrics
- Group Metrics
- Edit a Metrics Group
- Delete a Metrics Group
- Edit a Metric
- Delete a Metric
- Connect a Metric to a Job
- Connect a Metric to a Course
- Connect a Group of Metrics to a Job
- Connect a Group of Metrics to a Course
- Assess a Job Metrics for a User
- Assess a Metric for a User
- Ungroup a Metric
- Unlink a Metric from a Course
- Unlink a Metric from a Job
- Badges
- Content
- API usage
- Groups
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 curriculums | No | Integer | 100 |
| status | Curriculum status. Available values "active", "archived". Default is "active". | No | String | archived |
Example Request
https://api.schoox.com/v1/curriculums?apikey=schoox&acadId=386
Response Object
Show All
[{"id":1308,"title":"Innovalearn Curriculum","description":"","image":"https:\/\/www.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":"https:\/\/www.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 |
| external_id | Sets whether the userId given is the external_id of the User. By default, the value is "false" |
No | String | true |
| start | Starting Position | No | Integer | 0 |
| limit | Max size of retrieved curriculums | No | Integer | 100 |
Example Request
https://api.schoox.com/v1/curriculums?userId=14&apikey=schoox&acadId=386
Response Object
Show All
User is not a member of your academy
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 |
| userId | User's ID you want to retrieve his/her curriculum details | No | Integer | 3 |
| anyLanguage | When set true the call will return all courses regardless of language. By default, the value is "false" | No | String | true |
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":false,"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":10,"exams_num":2,"materials_num":"1"},{"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"}]}
Get A List of a Curriculum's Students
Returns a list a curriculum's users with details
GET /curriculums/:curriculum/students
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| 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 curriculum | No | Text | true |
Example Request
https://api.schoox.com/v1/curriculums/37/students?apikey=schoox&acadId=386
Response Object
Show All
[{"id":9538,"firstname":"John","lastname":"Smith","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/9538\/13334262631509726578.jpg","url":"https:\/\/www.schoox.com\/user\/9538\/","progress":0,"completebyadmin":false,"timespent":"0:42:31","certificates":[]},{"id":11925,"firstname":"John","lastname":"Alaister","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/11925\/13530717721409572663.jpg","url":"https:\/\/www.schoox.com\/user\/11925\/","progress":0,"completebyadmin":true,"timespent":"0:00:00","certificates":[{"tpId":37,"ver_code":"a540ac1","certification_time":"2016-09-27 10:19:17","userId":"11925","expiration_time":"0000-00-00 00:00:00"}]},{"id":13381,"firstname":"John","lastname":"Harmon","image":"https:\/\/content-cdn3.schoox.com\/content\/adaptive_resize-175-175\/users\/13381\/a0111a2647da3e80523a3002f6d86044.jpg","url":"https:\/\/www.schoox.com\/user\/13381\/","progress":100,"completebyadmin":false,"timespent":"7:44:36","certificates":[{"tpId":37,"ver_code":"335dadd","certification_time":"2014-04-08 13:31:11","userId":"13381","expiration_time":"0000-00-00 00:00:00"}]},{"id":66535,"firstname":"Eleni","lastname":"Sigkou","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/66535\/","progress":0,"completebyadmin":false,"timespent":"0:00:00","certificates":[]}]
Curriculum complete by admin
A Curriculum will be marked as "completed by Admin". The user's curriculum-progress will be updated and the curriculum completion will trigger several actions, such as: Award Curriculum Certificate, Award Badge, Award Credits, Update user's Curriculum-progress (if needed), Award Curriculum Certificate (if needed). You can send up to 10 user ids per call.
PUT curriculums/:curriculumid/completeByAdmin
Parameters
| Name | Description | Required | Type | Sample Value |
|---|---|---|---|---|
| acadId | Your academy ID | Yes | Integer | 386 |
| apikey | Your academy's API key | Yes | String | schoox |
| externalIds | Defines if the users' ids are external or not | Yes | String | false |
| completedAt | Defines the date when the Curriculum is marked as completed by the Admin, in YY-MM-DD date format. | No | Date | 2020-11-25 |
Example Request
https://api.schoox.com/v1/courses/37/completeByAdmin?externalIds=false&apikey=schoox&acadId=386
Request Object
Show All
{"users":[123,456,789]}Response Object
Show All
[{"user":{"id":123,"status":"success"}},{"user":{"id":456,"status":"success"}},{"user":{"id":789,"status":"failed"}}]