API Documentation /

API Method: modify

Modify a class

If you’re unsure of what a particular set of values will produce, our API Explorers can help. First create your example class with the create method’s API Explorer. Then, use the assigned class_id in the modify method’s API Explorer.

End point URL

http://classapi.wiziqxt.com/?method=modify

Authentication

This method requires authentication.

Select class type:

Parameter Type Description Example
class_id Required The unique ID assigned to this class by WizIQ. 4552
title Optional The name (title) of the class. English Class
start_time Optional The class's start time. Format is MM/DD/YYYY HH:MM:SS, but if HH:MM is sent, the WizIQ Virtual Classroom appends :00 12/13/2012 13:30
duration Optional How long the class is scheduled for, in minutes. Default is 60 minutes. 65
time_zone Optional The Time Zone that applies to this class. The default is GMT. America/Chicago
attendee_limit Optional The maximum number of attendees allowed in the class. The default is 2. 2
presenter_default_controls Optional Default controls available to the presenter in WizIQ Virtual Classroom. There are two possible values: audio and video. audio, video
attendee_default_controls Optional Default controls available to the attendee in WizIQ Virtual Classroom. There are two possible values: audio and writing. audio, writing
create_recording Optional Whether to record the class or not. Possible values: true (record) or false (don't record). Default is false. false
return_url Optional The URL users will be directed to when the class finishes. http://example.com/url
status_ping_url Optional The class's status. See here for parameters. http://example.com/url
presenter_email Optional This is the unique email of the presenter that will identify the presenter in WizIQ. Learn more. teacherinme@gmail.com
language_culture_name Optional Language culture name for class. en-us

Response XML Example

<rsp status="ok" call_id="g7hj8h2dgty4">
  <method>modify</method>
  <modify status="true">
  </modify>
</rsp>

Error Codes

1003 - Specified time_zone parameter is not available.

1004 - start_time parameter cannot precede current datetime.

1005 - Invalid start_time parameter.

1006 - time_zone parameter is missing.

1010 - duration parameter cannot exceed #MaxClassMinutes# minutes.

1011 - attendee_limit parameter cannot exceed #MaxUserPerClass# attendees.

1012 - Only #MaxConcurrentClass# simultaneous classes are allowed.

1015 - Cannot modify an in-progress class.

1016 - Cannot modify a completed class.

1017 - Cannot modify an expired class.

1018 - Cannot modify a deleted class.

1020 - class_id parameter is missing.

1022 - Datetime is not in valid format.

1031 - presenter_email is not valid.

1032 - You have already scheduled a class for the current time.

1043 - The language is invalid or unsupported in the VC.

1088 - class_master_id parameter is empty/invalid.

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

© 2017 WizIQ Inc. All rights reserved.