API OverviewManage teachers from your websiteManage teachers directly from your website and sync your account with WizIQ admin console.You can add and manage your teachers directly from your website through WizIQ REST API. You do not need to login to WizIQ.com in order to add/edit/delete your teachers.What's more?Add teachers to your WizIQ account using APIEdit teachers by changing their name/email/contact number/profile image/time zone.Give or take back schedule class permissions from teachersGet the list of your added teachers and their detailsActivate/de-activate any teacher anytime. Getting StartedTo get started, add teachers to your WizIQ organization account. To perform any activity through API a teacher account is required. Thus, you must add teacher to your organization account using API.Teacher API methods:add_teacher: add a teacher in your WizIQ accountedit_teacher: Edit teacher details get_teacher_details: get details about teacher(s)API Method: add_teacherParameterTypeDescriptionExamplenameRequiredName of the teacherMike Laremail RequiredEmail of the teachermike@example.compasswordRequiredSet Password for teacherxxxxxximage OptionalThe image path where teacher image is placedD:\Teachers list\mike.jpgphone_numberOptionalTeacher’s work phone number +1 xxxxxxxxxxmobile_numberOptionalTeacher’s mobile number+1 xxxxxxxxxxtime_zone OptionalTeacher’s time zoneAmerica/Chicagoabout_the_teacherOptionalAbout the teacherOnline Facilitator and Teacher, British Columbia, Canadacan_schedule_classOptionalDefault will be Truetrueis_activeOptionalDefault will be TrueTrueError Codes1069 Value to parameter is_active is not passed or invalid. Please pass either 0 or 1 or leave blank.1068 Value to parameter can_schedule_class is not passed or invalid. Please pass either 0 or 1 or leave blank.1067 Please pass valid email ID.1066 Please pass valid teacher id.1065 Invalid file format. Only jpg, jpeg, png, gif are allowed.1064 Teacher Email ID already exists. 1063 Your account has reached maximum limit of teachers. To add more teachers please contact sales@wiziq.com.1061 Please pass valid work phone with country code or leave blank. For example:+1 XXXXXXXXX1060 Please pass valid mobile number with country code or leave blank. For example:+1 XXXXXXXXX1059 Password with Spaces, with less than 6 characters length and more than 15 characters is not allowed.1058 Please pass valid name parameter maximum of 50 characters.1057 Teacher Email ID is required. API Method: edit_teacherParameterTypeDescriptionExampleteacher_idRequiredUnique id of teacher which is returned by add_teacher method.1482nameRequiredName of the teacherMike Laremail RequiredEmail of the teachermike@example.compasswordRequiredSet Password for teacherxxxxxxImageOptionalThe image path where teacher image is placedD:\Teachers list\mike.jpgphone_numberOptionalTeacher’s work phone number +1 XXXXXXXXXXmobile_numberOptionalTeacher’s mobile number+1 XXXXXXXXXXtime_zone OptionalTeacher’s time zoneAmerica/Chicagoabout_the_teacherOptionalAbout the teacherOnline Facilitator and Teacher, British Columbia, Canadacan_schedule_classOptionalDefault will be TrueTrueis_activeOptionalDefault will be TrueTrueError Codes1069 Value to parameter is_active is not passed or invalid. Please pass either 0 or 1 or leave blank.1068 Value to parameter can_schedule_class is not passed or invalid. Please pass either 0 or 1 or leave blank.1067 Please pass valid email ID.1066 Please pass valid teacher id.1065 Invalid file format. Only jpg, jpeg, png, gif are allowed.1064 Teacher Email ID already exists. 1063 Your account has reached maximum limit of teachers. To add more teachers please contact sales@wiziq.com.1061 Please pass valid work phone with country code or leave blank. For example:+1 XXXXXXXXX1060 Please pass valid mobile number with country code or leave blank. For example:+1 XXXXXXXXX1059 Password with Spaces, with less than 6 characters length and more than 15 characters is not allowed.1058 Please pass valid name parameter maximum of 50 characters.1057 Teacher Email ID is required. API Method: get_teacher_detailsGet details of your teacher: This method will return the details of added teacher.ParameterTypeDescriptionExampleteacher_idOptionalUnique id of teacher which is returned by add_teacher method.1482-If teacher_id is passed to method then it will return details of that specific teacher.-If teacher_id is not passed, it will return details of all teachers that are added in your account.FAQ: - Why is it important to add teacher?To perform any activity through API a teacher email is required. Thus, you must add teacher to your organization account.To add a teacher account, you can use API method add_teacher. Or also you can add teacher from WizIQ dashboard by following these steps:1. Log in to your WizIQ account.2. Mouse over Account on the top left navigation bar.3. Select Org Dashboard.4. Click the Add Teacher button and follow as prompted.
Description
Manage teachers from your website
Manage teachers directly from your website and sync your account with WizIQ admin console.
You can add and manage your teachers directly from your website through WizIQ REST API. You do not need to login to WizIQ.com in order to add/edit/delete your teachers.
What's more?
Add teachers to your WizIQ account using API
Edit teachers by changing their name/email/contact number/profile image/time zone.
Give or take back schedule class permissions from teachers
Get the list of your added teachers and their details
Activate/de-activate any teacher anytime.
Presentation Transcript
Your Facebook Friends on WizIQ