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

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
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=schoox&acadId=386

Response Object
Show All
{"skills":{"academySkills":[{"skillId":367,"name":"Alcohol Serving","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":368,"name":"Food Prep","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":439,"name":"hygiene","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":492,"name":"Upselling","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":493,"name":"Identifying the right customers","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":2206,"name":"abc","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":9553,"name":"Microsoft Excel","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43782,"name":"Advising","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43783,"name":"Analysis","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43784,"name":"Being Thorough","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43785,"name":"Budgeting","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43786,"name":"Calculations","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43787,"name":"Collaboration","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43788,"name":"Communication","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43789,"name":"Construction","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43790,"name":"Creating Ideas","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43791,"name":"Creating Innovation","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43792,"name":"Creative Thinking","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43793,"name":"Creativity","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43794,"name":"Defining Problems","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43795,"name":"Detail Management","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43796,"name":"Emotional Control","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43797,"name":"Equipment Operation","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43798,"name":"Fundraising","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43799,"name":"Handling Complaints","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43800,"name":"Innovation","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43801,"name":"Interpersonal communication","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43802,"name":"Leadership","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43803,"name":"Logical Thinking","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43804,"name":"Management","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43805,"name":"Negotiation","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43806,"name":"Organizational Management","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43807,"name":"Organizational Tasks","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43808,"name":"Personal Interaction","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43809,"name":"Plan Development","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43810,"name":"Planning","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43811,"name":"Public Relations","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43812,"name":"Responsibility","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43813,"name":"Scheduling","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43814,"name":"Team Building","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43815,"name":"Training","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43816,"name":"Ability to work under pressure ","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43817,"name":"Administering medication ","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43818,"name":"Attention to detail","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43819,"name":"Conflict resolution ","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43820,"name":"Customer service skills","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43821,"name":"Dealing with complaints","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43822,"name":"Inspecting equipment","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43823,"name":"Leading teams","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43824,"name":"Problem solving skills","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43825,"name":"Selling ideas","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43826,"name":"Serving people","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43827,"name":"Teaching skills ","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43828,"name":"Teamwork skills","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43829,"name":"Clearing the table","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43830,"name":"Cooking","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43831,"name":"Following a recipe","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43832,"name":"Setting the table","type":{"typeId":"200","title":"Skill"},"levels":[],"industry":null,"tier":null,"category":null},{"skillId":43833,"name":"Integrity","type":{"typeId":"200","title":"Skill"},"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

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/skills?apikey=schoox&acadId=386

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/group

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/skills/3/group?apikey=schoox&acadId=386

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

Edit a Metrics Group

Edits a group of metrics

PUT /skills/:groupid/group

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?apikey=schoox&acadId=386

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

Delete a Metrics Group

Deletes a group of metrics

DELETE /skills/:groupid/group

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/skills/3/group?apikey=schoox&acadId=386

Edit a Metric

Edits a custom metric

PUT /skills/:skillid/

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
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/367?apikey=schoox&acadId=386

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

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
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/367?apikey=schoox&acadId=386

Connect a Metric to a Job

Connects a metric to a job with a proficiency level.

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

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/skills/367/jobs/230/level/10?apikey=schoox&acadId=386

Request Object
Show All
{"weight":20}

Connect a Metric to a Course

Connects a metric to a course.

PUT /skills/:skillId/course/:courseId

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/skills?apikey=schoox&acadId=386

Connect a Group of Metrics to a Job

Connects a group to a job.

PUT /skills/:groupId/jobgroup/:jobId

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/skills?apikey=schoox&acadId=386

Connect a Group of Metrics to a Course

Connects a group to a course.

PUT /skills/:groupId/coursegroup/:courseId

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/skills/3/coursegroup/11657?apikey=schoox&acadId=386

Assess a Job Metrics for a User

Assess job metrics of a user

PUT /skills/:jobid/jobskillsassessment/:userid

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
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/230/jobskillsassessment/14?apikey=schoox&acadId=386

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

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
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/367/skillassessment/14?apikey=schoox&acadId=386

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

Ungroup a Metric

Ungroup a Metric

DELETE /skills/:skillid/group/:groupId

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/skills/1/group/2?apikey=schoox&acadId=386

Unlink a Metric from a Course

Unlinks a metric from a Course

DELETE /skills/:skillid/course/:courseId

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/skills/1/course/2?apikey=schoox&acadId=386

Unlink a Metric from a Job

Unlinks a metric from a Job

DELETE /skills/:skillid/job/:jobId

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/skills/1/job/2?apikey=schoox&acadId=386