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
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 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=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":93769,"title":"Curriculum 1","description":"Curriculum 1\n","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/academy\/APIAcademytest\/curriculum\/card\/93769","private":true,"courses":1}]
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?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 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=2099521483&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":93769,"title":"Curriculum 1","description":"Curriculum 1\n","image":null,"url":"https:\/\/www.schoox.com\/academy\/APIAcademytest\/curriculum\/card\/93769","private":false,"courses":1,"progress":100,"timespent":"0:00:00","certificates":[{"id":"93769:2099521483:b5cf96f","tpId":93769,"ver_code":"b5cf96f","certification_time":"2022-08-26 13:03:49","userId":2099521483,"expiration_time":"0000-00-00 00:00:00","expired":"active"}]}]
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
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 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/93769?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
{"id":93769,"title":"Curriculum 1","description":"Curriculum 1\n","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/curriculum\/images\/curriculum_default_image.png","url":"https:\/\/www.schoox.com\/academy\/APIAcademytest\/curriculum\/card\/93769","private":true,"enrolled":false,"courses":[{"id":3703886,"title":"Course 1","description":"Course 1\n","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/course\/images\/Course_default_image.png","url":"https:\/\/www.schoox.com\/3703886\/course-1","lectures_num":1,"exams_num":1,"materials_num":0}]}
Get A List of a Curriculum's Students
Returns a list a curriculum's users with details
GET /curriculums/:curriculum/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 curriculum | No | Text | 1 |
| completionStartDate | Return only users that have completed the curriculum after given start date | No | Date | 2016-06-08 |
| completionEndDate | Return only users that have completed the curriculum before given end date | No | Date | 2016-08-08 |
Example Request
https://api.schoox.com/v1/curriculums/93769/students?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
Response Object
Show All
[{"id":473159548,"firstname":"Frank","preferred_name":"test","lastname":"Doe","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/473159548\/","progress":0,"completebyadmin":false,"timespent":"0:00:00","certificates":[]},{"id":2099521483,"firstname":"John","preferred_name":null,"lastname":"Doe","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","url":"https:\/\/www.schoox.com\/user\/2099521483\/","progress":100,"completebyadmin":false,"timespent":"0:00:00","certificates":[{"id":"93769:2099521483:b5cf96f","tpId":93769,"ver_code":"b5cf96f","certification_time":"2022-08-26 13:03:49","userId":2099521483,"expiration_time":"0000-00-00 00:00:00","expired":"active"}]}]
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
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 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/curriculums/37/completeByAdmin?externalIds=false&apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108
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"}}]