Menu

Search

Electa Live Virtual Classroom, LMS - Help & Support Portal


API 3.0 - Scheduling Live Sessions


Administrator
API 3.0

This topic describes how to create live events in your Electa calendar using an API call. Please note you may not need to create live events if you are using the Direct Classroom Access Api and if you have your own scheduling system.

 

Call: <API_URL>/Event/Create
Supported HTML Methods: HTTP-GET / HTTP-POST
Communications Level: Server-to-Server
Result: XML

Parameters:

CID - Integer, Required, Account Id, Sample: 12345

Token - String, Required, Sample: 9C467079-FE3B-45C5-8AA5-9726397081AA
A valid session token obtain from a previous call to the Authentication namespace for the above Account Id.

StartDateTime -  String, Required, mm/dd/yyyy hh:mm:ss, Sample: 12/18/2018 23:45:00
The beginning date and time of the live session. 

TimeZoneId
- Integer, Options, Sample: 101
The time zone identifier in which the above date/time is specified. You can get all time zone identifiers from the Time Zone API.
If not provided the company default time zone will be used. This is configured on the Account Settings > Look & Feel page.

RoomId - Integer, Optional, Sample: 1234, The room ID number that will hold the event.

PresenterId - Integer, Optional, Sample: 22329843
The number id of the user set as an event organizer. Could be any of your teachers.
If not specified the account master admin will be used.

EventType - Character, Required, Values: A, B. Sample: A.
Specifies the type of event. Please refer to the Event Access Types guide for more details.
Through the API only events of type A and B can be created.

Duration - Integer, Required. The event duration in minutes. The following values are supported:
{ 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 90, 120, 180, 240, 300, 360, 420, 480, 540, 600, 660, 720, 1440 }

Topic - String, Required. The topic/title of the event to show in the calendar.

ShowInPublicCalendar - Boolean, Required. If True the event is listed in all published calendars.
If False the event is only listed in the calendars of the logged users.

If the call succeeds an XML result is returned with the newly created event details. If the call fails the result is the error code.

Sample Call

https://api30.school-network.net/event/create?token=b63b8ee4-16e3-4bff-a125-7a6a06af34b9&cid=12345&PresenterId=122211&roomid=2221&EventType=B&StartDateTime=6/21/2018 10:00&timezoneid=95&Duration=30&topic=Sample%20Topic&ShowinPublicCalendar=false

Sample Result

<?xml version='1.0' encoding='UTF-8'?>
<NewEvent>
    <CompanyId>12345</CompanyId>
    <PresenterId>122211</PresenterId>
    <RoomId>2221</RoomId>
    <StartDateTime>6/21/2018 10:00</StartDateTime>
    <Duration>30</Duration>
    <TimeZoneId>95</TimeZoneId>
    <EventId>255052</EventId>
    <AccessCode>12550528</AccessCode>
    <Topic>10 hour session</Topic>
    <AccessType>B</AccessType>
    <EventOpenPrior>5</EventOpenPrior>
    <EventURL>https://www.school-network.net/event/join/12550528</EventURL>
</NewEvent>

The XML result contains as pass back parameters your company id, presenter id, room id, start date and time as well as the time zone. Also the internal event ID and access code are provided. The Event URL can be published to allow users to attend from your website.

 


Also In This Category


Optionally provide private feedback to help us improve this article...

Thank you for your feedback!


Details
Last Modified: Last Month
Last Modified By: Administrator
Type: INFO
Article not rated yet.
Article has been viewed 146 times.
Options