API Documentation

Events

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

Get a List of ILT Events

Returns a list of In-Class Training Events for a specific date range.

GET /events/ilt

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
dateStart Start date for the events No Date 2016-06-08
dateEnd End date for the events No Date 2016-06-09
start Starting Position No Integer 0
limit Number of events to return per request. Default to 20 No Integer 100
Example Request

https://api.schoox.com/v1/events/ilt?dateStart=2016-06-08&dateEnd=2016-06-09&apikey=schoox&acadId=386

Response Object
Show All
{"all":1,"events":[{"id":18779,"title":"Demo Event","attendeesNr":0,"description":"Fun","location":"Broadway St, North Washington, CO 80216, USA"}]}

Get a List of ILT Event's Participants

Returns a list of Event's registrants.

GET /events/ilt/:eventid/users

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
start Starting Position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 20 No Integer 100
Example Request

https://api.schoox.com/v1/events/ilt/77692/users?apikey=schoox&acadId=386

Response Object
Show All
{"title":"TEST ILT","start_date":"2018-02-14T07:00:00+00:00","end_date":"2018-02-14T15:00:00+00:00","users_count":5,"instructors":[{"id":53970,"firstname":"Cara","lastname":"Rizzo","email":"api@schoox.com"}],"users":[{"id":"37347121","firstname":"OTIS","lastname":"WILLIAMS","email":"","approved":"Yes"},{"id":"805009739","firstname":"Adam","lastname":"Williams","email":"","approved":"Yes"},{"id":"1177469004","firstname":"Robert","lastname":"Williams","email":"","approved":"Yes"},{"id":"436554993","firstname":"John","lastname":"Williamson","email":"","approved":"Yes"},{"id":"1223466249","firstname":"Tyrone","lastname":"Willingham","email":"","approved":"Yes"}]}

Get a List of Virtual Classroom Events

Returns a list of Virtual Classroom Events for a specific date range.

GET /events/vc

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
dateStart Start date for the events No Date 2015-03-07
dateEnd End date for the events No Date 2015-03-08
start Starting Position No Integer 0
limit Number of events to return per request. Default to 20 No Integer 100
Example Request

https://api.schoox.com/v1/events/vc?dateStart=2015-03-07&dateEnd=2015-03-08&apikey=schoox&acadId=386

Response Object
Show All
{"all":1,"events":[{"id":134,"title":"Live Session","attendeesNr":0,"description":"no description"}]}

Get a List of Virtual Classroom Event's Participants

Returns a list of Event's registrants.

GET /events/vc/:eventid/users

Parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 386
apikey Your academy's API key Yes String schoox
start Starting Position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 20 No Integer 100
Example Request

https://api.schoox.com/v1/events/vc/30276/users?apikey=schoox&acadId=386

Response Object
Show All
{"title":"Test LIve Session","start_date":"2018-02-19T07:00:00+00:00","end_date":"2018-02-19T15:00:00+00:00","users_count":5,"instructors":[{"id":53970,"firstname":"Cara","lastname":"Rizzo","email":"api@schoox.com"}],"users":[{"id":"1354672726","firstname":"Rosa","lastname":"Zavala","email":"","approved":"Yes"},{"id":"1619451059","firstname":"Tammie","lastname":"Zeus","email":"","approved":"Yes"},{"id":"1189680775","firstname":"Benjamin","lastname":"Ziegler","email":"","approved":"Yes"},{"id":"1290654741","firstname":"Chris","lastname":"Zorich","email":"","approved":"Yes"},{"id":"239905875","firstname":"ZoubinHS","lastname":"ZoubinHS","email":"","approved":"Yes"}]}