WizIQ API Documentation
Getting Started
To get started, add teachers to your WizIQ organization account. To perform any
activity through API, a teacher email is required. Thus, you must add teacher to
your organization account.
WizIQ Teacher API Documentation
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.
WizIQ Virtual Classroom API Documentation
Using this API, you can schedule and manage virtual classroom sessions through your
teaching website. Enable or disable the download of class recordings as well.
Class Status pings
To communicate the status of a class, recording or attendance report, WizIQ sends
following parameters through POST method in several pings to the URL sent by you
in status_ping_url parameter of 'create' method.
Learn more
Content API Methods:
upload
Upload content
delete
Delete content
Content Status pings
To communicate the status of a content, WizIQ sends following parameters through
POST method in several pings to the URL sent by you in status_ping_url
parameter of 'upload' method.
Learn more
Introduction to the WizIQ Virtual Classroom API
The WizIQ Virtual Classroom API is used to integrate the WizIQ Virtual Classroom
with your website. This API allows you to do the following directly from your site:
- Access class activities
- Schedule and manage classes
- Conduct classes
- View attendance reports
- View class recordings
The WizIQ Virtual Classroom API uses HTTP, the same protocol web sites and browsers
use to interact.
Anatomy of a WizIQ Virtual Classroom API request
All WizIQ Virtual Classroom API methods use the same general format:
<?xml version="1.0" encoding="utf-8" ?>
<rsp status="ok">
[xml-payload-here]
</rsp>
The XML payload contains the actual request. For example, here is a class creation
request:
<rsp status="ok">
<method>create</method>
<create status="true">
<class_details>
<class_id>572513 </class_id>
<recording_url> <![CDATA[http://authorlive.com/aliveext
/Recorded.aspx?SessionCode=oBtenWN1Ez4%3d]]></recording_url>
<presenter_list>
<presenter>
<presenter_id><![CDATA[2345]]></presenter_id>
<presenter_url><![CDATA[http://authorlive.com/
aliveext/LoginToSession.aspx?
SessionCode=j3onNyPCpFrSAliy4ZV9Kw%3d%3d]]></presenter_url>
</presenter>
</presenter_list>
</class_details>
</create>
</rsp>
Note: See the documentation pages for each WizIQ Virtual Classroom
method to see more example requests.
Anatomy of a WizIQ Virtual Classroom API response
All WizIQ Virtual Classroom API responses return in one of two formats: a successful
request, or an error.
Note: See the documentation pages for each WizIQ Virtual Classroom
method to see more example responses and relevant error messages.
Anatomy of a failed WizIQ Virtual Classroom API response
If your request returns an error, the response container consists of:
<?xml version="1.0" encoding="utf-8" ?>
<rsp status="fail">
<error code="[error-code]" msg="[error-message]" />
</rsp>
Anatomy of a successful WizIQ Virtual Classroom API response
If your request succeeds, the response container consists of the information you
asked for. Here’s an example class creation response:
<rsp status="ok">
<method>create</method>
<create status="true">
<class_details>
<class_id>572513</class_id>
<recording_url><![CDATA[http://authorlive.com/aliveext
/Recorded.aspx?SessionCode=HyvKj1NWi6M%3d]]></recording_url>
<presenter_list>
<presenter>
<presenter_id><![CDATA[269052]]></presenter_id>
<presenter_url><![CDATA[http://authorlive.com/
aliveext/LoginToSession.aspx?
SessionCode=S9JzZwvk0sN%2fA3mMJ2x4lg%3d%3d]]>
</presenter_url>
</presenter>
</presenter_list>
</class_details>
</create>
</rsp>