API Documentation

Skills

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

Get a List of Skills

Returns a list of all skill types

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
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":0,"name":null},"levels":[]},{"skillId":368,"name":"Food Prep","type":{"typeId":0,"name":null},"levels":[]},{"skillId":439,"name":"hygiene","type":{"typeId":0,"name":null},"levels":[]},{"skillId":492,"name":"Upselling","type":{"typeId":0,"name":null},"levels":[]},{"skillId":493,"name":"Identifying the right customers","type":{"typeId":0,"name":null},"levels":[]},{"skillId":2206,"name":"abc","type":{"typeId":0,"name":null},"levels":[]},{"skillId":9553,"name":"Microsoft Excel","type":{"typeId":0,"name":null},"levels":[]}],"academySystemSkills":[{"skillId":139,"name":"Ability to work under pressure ","type":{"typeId":0,"name":null},"levels":[]},{"skillId":142,"name":"Administering medication ","type":{"typeId":0,"name":null},"levels":[]},{"skillId":31,"name":"Advising","type":{"typeId":0,"name":null},"levels":[]},{"skillId":32,"name":"Analysis","type":{"typeId":0,"name":null},"levels":[]},{"skillId":147,"name":"Attention to detail","type":{"typeId":0,"name":null},"levels":[]},{"skillId":35,"name":"Being Thorough","type":{"typeId":0,"name":null},"levels":[]},{"skillId":36,"name":"Budgeting","type":{"typeId":0,"name":null},"levels":[]},{"skillId":37,"name":"Calculations","type":{"typeId":0,"name":null},"levels":[]},{"skillId":319,"name":"Clearing the table","type":{"typeId":0,"name":null},"levels":[]},{"skillId":41,"name":"Collaboration","type":{"typeId":0,"name":null},"levels":[]},{"skillId":42,"name":"Communication","type":{"typeId":0,"name":null},"levels":[]},{"skillId":167,"name":"Conflict resolution ","type":{"typeId":0,"name":null},"levels":[]},{"skillId":46,"name":"Construction","type":{"typeId":0,"name":null},"levels":[]},{"skillId":320,"name":"Cooking","type":{"typeId":0,"name":null},"levels":[]},{"skillId":50,"name":"Creating Ideas","type":{"typeId":0,"name":null},"levels":[]},{"skillId":51,"name":"Creating Innovation","type":{"typeId":0,"name":null},"levels":[]},{"skillId":54,"name":"Creative Thinking","type":{"typeId":0,"name":null},"levels":[]},{"skillId":55,"name":"Creativity","type":{"typeId":0,"name":null},"levels":[]},{"skillId":175,"name":"Customer service skills","type":{"typeId":0,"name":null},"levels":[]},{"skillId":176,"name":"Dealing with complaints","type":{"typeId":0,"name":null},"levels":[]},{"skillId":57,"name":"Defining Problems","type":{"typeId":0,"name":null},"levels":[]},{"skillId":59,"name":"Detail Management","type":{"typeId":0,"name":null},"levels":[]},{"skillId":63,"name":"Emotional Control","type":{"typeId":0,"name":null},"levels":[]},{"skillId":66,"name":"Equipment Operation","type":{"typeId":0,"name":null},"levels":[]},{"skillId":327,"name":"Following a recipe","type":{"typeId":0,"name":null},"levels":[]},{"skillId":70,"name":"Fundraising","type":{"typeId":0,"name":null},"levels":[]},{"skillId":72,"name":"Handling Complaints","type":{"typeId":0,"name":null},"levels":[]},{"skillId":76,"name":"Innovation","type":{"typeId":0,"name":null},"levels":[]},{"skillId":212,"name":"Inspecting equipment","type":{"typeId":0,"name":null},"levels":[]},{"skillId":350,"name":"Integrity","type":{"typeId":0,"name":null},"levels":[]},{"skillId":77,"name":"Interpersonal communication","type":{"typeId":0,"name":null},"levels":[]},{"skillId":84,"name":"Leadership","type":{"typeId":0,"name":null},"levels":[]},{"skillId":222,"name":"Leading teams","type":{"typeId":0,"name":null},"levels":[]},{"skillId":87,"name":"Logical Thinking","type":{"typeId":0,"name":null},"levels":[]},{"skillId":90,"name":"Management","type":{"typeId":0,"name":null},"levels":[]},{"skillId":97,"name":"Negotiation","type":{"typeId":0,"name":null},"levels":[]},{"skillId":101,"name":"Organizational Management","type":{"typeId":0,"name":null},"levels":[]},{"skillId":102,"name":"Organizational Tasks","type":{"typeId":0,"name":null},"levels":[]},{"skillId":105,"name":"Personal Interaction","type":{"typeId":0,"name":null},"levels":[]},{"skillId":106,"name":"Plan Development","type":{"typeId":0,"name":null},"levels":[]},{"skillId":107,"name":"Planning","type":{"typeId":0,"name":null},"levels":[]},{"skillId":254,"name":"Problem solving","type":{"typeId":0,"name":null},"levels":[]},{"skillId":117,"name":"Public Relations","type":{"typeId":0,"name":null},"levels":[]},{"skillId":127,"name":"Responsibility","type":{"typeId":0,"name":null},"levels":[]},{"skillId":129,"name":"Scheduling","type":{"typeId":0,"name":null},"levels":[]},{"skillId":283,"name":"Selling ideas","type":{"typeId":0,"name":null},"levels":[]},{"skillId":285,"name":"Serving people","type":{"typeId":0,"name":null},"levels":[]},{"skillId":335,"name":"Setting the table","type":{"typeId":0,"name":null},"levels":[]},{"skillId":298,"name":"Teaching skills ","type":{"typeId":0,"name":null},"levels":[]},{"skillId":134,"name":"Team Building","type":{"typeId":0,"name":null},"levels":[]},{"skillId":300,"name":"Teamwork skills","type":{"typeId":0,"name":null},"levels":[]},{"skillId":137,"name":"Training","type":{"typeId":0,"name":null},"levels":[]}]}}

Add Skills

Creates a new custom skill and adds it to the academy or adds a system skill to the academy. Max 10 skills / 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 Skills

Groups a number of skills

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 Skills Group

Edits a group of skills

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 Skills Group

Deletes a group of skills

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 Skill

Edits a custom skill

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 skill.
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 Skill

Deletes a skill

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 skill.
By default, the value is "false"
No String true
Example Request

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

Connect a Skill to a Job

Connects a skill 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 Skill to a Course

Connects a skill 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 Skills 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 Skills 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 Skills for a User

Assess job skills 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 skill 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 Skill for a User

Assess skill 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 Skill

Ungroup a Skill

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 Skill from a Course

Unlinks a skill 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 Skill from a Job

Unlinks a skill 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