API Documentation

Metrics

The following requests relate to getting information regarding the metrics of the Schoox Academy API. Note: All requests must be Authenticated.

Get a List of Metrics

Returns a list of all custom and system academy metrics

GET /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
typeId Filter the metrics by the specific metric type id No Integer 3
search Search term No String Communication
industryId Get metrics that have the specific industry No Integer 4
tierId Get metrics that have the specific tier No Integer 2
categoryId Get metrics that have the specific category No Integer 6
start Starting Position No Integer 25
limit Number of courses to return per request, up to maximum of 100. Default to 100 No Integer 53
Example Request

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

Response Object
Show All
{"skills":{"academySkills":[{"skillId":135035,"name":"General Communication Skill","type":{"typeId":"33824","title":"Communication Skills"},"levels":[],"industry":null,"tier":null,"category":null}],"academySystemSkills":[]}}

Add Metrics

Creates a new custom metric and adds it to the academy or adds a system metric to the academy. Max 10 metrics / request

POST /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/skills?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
[{"title":"Calculations","isSystemSkill":"true"},{"title":"Skill 1","isSystemSkill":"false","type":"SkillTypeId", "description":"Skill Description"},{"title":"Skill 2","isSystemSkill":"false", "type":"Skill","type":"SkillTypeId", "description":"Skill Description"}]

Group Metrics

Groups a number of metrics

PUT /skills/:groupid/group

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/skills/17697/group?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
{"name":"Sample Group","skills":[1,2]}

Edit a Metrics Group

Edits a group of metrics

PUT /skills/:groupid/group

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/skills/17697/group?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
{"name":"Sample Group","skills":[1,2]}

Delete a Metrics Group

Deletes a group of metrics

DELETE /skills/:groupid/group

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/skills/17697/group?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Edit a Metric

Edits a custom metric

PUT /skills/:skillid/

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
title Sets whether the id given is the title of the metric.
By default, the value is "false"
No String true
Example Request

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

Request Object
Show All
{"title":"Custom Skill", "type":"Skill", "description":"Skill Description", "levelsDecription":[{"Basic Understanding":"Level Description 1"}, {"Working Experience":"Level Description 2"}, {"Extensive Experience":"Level Description 3"}, {"Subject matter depth/breadth":"Level Description 4"}]}

Delete a Metric

Deletes a metric

DELETE /skills/:skillid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
title Sets whether the id given is the title of the metric.
By default, the value is "false"
No String true
Example Request

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

Connect a Metric to a Job

Connects a metric to a job with a proficiency level.

PUT /skills/:skillId/job/:jobId/level/:level_id

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/skills/135035/jobs/1009130/level/10?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
{"weight":20}

Connect a Metric to a Course

Connects a metric to a course.

PUT /skills/:skillId/course/: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
Example Request

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

Connect a Group of Metrics to a Job

Connects a group to a job.

PUT /skills/:groupId/jobgroup/:jobId

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/skills/17697/jobgroup/1009130?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Connect a Group of Metrics to a Course

Connects a group to a course.

PUT /skills/:groupId/coursegroup/: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
Example Request

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

Assess a Job Metrics for a User

Assess job metrics of a user

PUT /skills/:jobid/jobskillsassessment/: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 id given is the external_id of the User.
By default, the value is "false"
No String true
is_email Sets whether the id given is the email of the user.
By default, the value is "false"
No String true
title Sets whether the id given is a metric title.
By default, the value is "false"
No String true
type_id Sets the assessment score type. Accepted values 1 or 2 No String 1
Example Request

https://api.schoox.com/v1/skills/1009130/jobskillsassessment/2099521483?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
{"comment":"This is a comment","skillsScore":[{"id":367,"value":10}]}

Assess a Metric for a User

Assess metric of a user

PUT /skills/:skillid/skillassessment/: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 id given is the external_id of the User.
By default, the value is "false"
No String true
is_email Sets whether the id given is the email of the user.
By default, the value is "false"
No String true
type_id Sets the assessment score type. Accepted values 1 or 2 No String 1
Example Request

https://api.schoox.com/v1/skills/135035/skillassessment/2099521483?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Request Object
Show All
{"comment":"This is a comment","score":20}

Ungroup a Metric

Ungroup a Metric

DELETE /skills/:skillid/group/:groupId

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/skills/1/group/2?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Unlink a Metric from a Course

Unlinks a metric from a Course

DELETE /skills/:skillid/course/: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
Example Request

https://api.schoox.com/v1/skills/1/course/2?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Unlink a Metric from a Job

Unlinks a metric from a Job

DELETE /skills/:skillid/job/:jobId

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/skills/1/job/2?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108