Status pings

If you need to know the current status of a class, recording or attendance report, the WizIQ Virtual Classroom API offers the create method's status_ping_url parameter. When these objects are available, a ping is sent through the POST method to the URL you supplied in the request. You can access these parameters using the form collection for the results page.

For example, in C# you can get the class_id parameter from the results with the following code:

string class_id= Request.Form['class_id'].ToString();

Status ping parameters

The following table details the parameters provided by a status ping, requested through status_ping_url.

Parameter Description Example
attendance_report_file Access the XML file containing the class's attendance report. attendance_report_xml
attendance_report_status There is a short time lag between when a class completed, and when the attendance report's available for download. When the file's ready for download, this parameter returns the status available. available
class_id The unique ID assigned to this class by WizIQ. Always included in the results. 11979
class_status The current status of this class. See the next table for the list of possible statuses. live
recording_status There is a short time lag between when a class completed, and when the recording's available for download. When the file's ready for download, this parameter returns the status available. available

Possible class_status values

The following table details the possible values of class_status_ping's class_status parameter.

Value Description
class_status=completed The class is over.
class_status=expired The class's assigned time has finished, but no one launched the class.
class_status=live The first person has entered the class, whether a student or the instructor.

For enquiries: Call us at +1-919-647-4727 -or- Contact us

© 2017 WizIQ Inc. All rights reserved.