API Documentation

Badges

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

List of badges

Returns a list of all badges according to their type

GET /badges

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
badge_type The badge type of the badges requested
Possible values "schoox", "group", "academy". By default, the value is "schoox".
No String academy
Example Request

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

Response Object
Show All
[{"id":12,"title":"Good Question","description":"Some say that a good question is at least as valuable as a good answer and reflects the sharpness of the mind.  Your question is important and is the spark for further discussion and knowledge. ","image":"icon_good_question","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":13,"title":"Great Team Worker","description":"Team working is one of the most important skills and can yield to great achievements. You proved that you have the skill to work effectively and constructively within a team. ","image":"icon_great_supporter","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":14,"title":"Hard Worker","description":"No matter how smart you are, you won't get far if you dont work hard in your life. All great achievements have been accomplished by great people who worked really hard in life. You are a hard worker. Keep going!","image":"icon_hard_worker","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":15,"title":"Great Mentor","description":"A mentor is someone who influences others life in a very positive way by using their life experience and wisdom. You are a great mentor. ","image":"icon_mentor","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":16,"title":"Fellow Helper","description":"Providing help to fellow members of your institution (e.g. co-workers, fellow students) is of great importance. Your help was very important.  ","image":"icon_co-worker_helper","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":18,"title":"Great Performance","description":"Solving a difficult and tough problem or accomplishing a great achievement deserves a special badge.  This badge is for your great performance. ","image":"icon_group_member_of_the_month","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":77,"title":"Good Answer","description":"A good answer to a question is the premise of knowledge sharing.  Your answer is valuable for the community. ","image":"icon_good_answer","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":78,"title":"Good Student","description":"You did a great job as a student. You completed your course, participated actively in the discussion board, asked good questions and tried to answer questions of your fellow students. Keep trying!","image":"icon_good_student","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":79,"title":"Good Teacher","description":"You did a great job as a Teacher. Your course is really great. It is comprehensive and easy to understand. In the discussion board you made a real effort to answer all questions correctly and accurately. You provided student with valuable supplemental material. Teachers like you help people understand the world!","image":"icon_good_teacher","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null}]

Award a badge

Awards badge to a list of users. Max 10 user per request

GET /badges/:badgeid/award

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/badges/:badgeid/award?apikey=schoox&acadId=386

Request Object
Show All
{"user_ids":[1,2,3,4]}
Response Object
Show All
[{"id":12,"title":"Good Question","description":"Some say that a good question is at least as valuable as a good answer and reflects the sharpness of the mind.  Your question is important and is the spark for further discussion and knowledge. ","image":"icon_good_question","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":13,"title":"Great Team Worker","description":"Team working is one of the most important skills and can yield to great achievements. You proved that you have the skill to work effectively and constructively within a team. ","image":"icon_great_supporter","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":14,"title":"Hard Worker","description":"No matter how smart you are, you won't get far if you dont work hard in your life. All great achievements have been accomplished by great people who worked really hard in life. You are a hard worker. Keep going!","image":"icon_hard_worker","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":15,"title":"Great Mentor","description":"A mentor is someone who influences others life in a very positive way by using their life experience and wisdom. You are a great mentor. ","image":"icon_mentor","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":16,"title":"Fellow Helper","description":"Providing help to fellow members of your institution (e.g. co-workers, fellow students) is of great importance. Your help was very important.  ","image":"icon_co-worker_helper","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":18,"title":"Great Performance","description":"Solving a difficult and tough problem or accomplishing a great achievement deserves a special badge.  This badge is for your great performance. ","image":"icon_group_member_of_the_month","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"2","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":77,"title":"Good Answer","description":"A good answer to a question is the premise of knowledge sharing.  Your answer is valuable for the community. ","image":"icon_good_answer","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":78,"title":"Good Student","description":"You did a great job as a student. You completed your course, participated actively in the discussion board, asked good questions and tried to answer questions of your fellow students. Keep trying!","image":"icon_good_student","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null},{"id":79,"title":"Good Teacher","description":"You did a great job as a Teacher. Your course is really great. It is comprehensive and easy to understand. In the discussion board you made a real effort to answer all questions correctly and accurately. You provided student with valuable supplemental material. Teachers like you help people understand the world!","image":"icon_good_teacher","ribbon":"1","ext":"png","ownerId":"0","ownerType":"schoox","awardable":"1","parameters":null,"memberId":"0","timecreated":"123456789","awardJobs":null,"editor":null,"icon":null}]