Menu

Search

Electa Live Virtual Classroom, LMS - Help & Support Portal


API 3.0 - Recorded Sessions, Listing


Administrator
API 3.0

With this API call you can obtain a list of your recorded sessions for a specified room Id and a time frame.

  Call: <API_URL>/Recordings/List/
Supported HTML Methods: GET
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.

StartDateTimeUTC -  String, optional, mm/dd/yyyy hh:mm:ss, Sample: 12/18/2018 23:45:00
The beginning date and time to start from. 

EndDateTimeUTC
- String, optional, mm/dd/yyyy hh:mm:ss, Sample: 12/20/2018 12:45:00
The end date and time to include in the list.

If no dates are specified the system will display all of the items for the provided virtual room.
If only Start date is specified the call will return the logs starting from this date.
If only End date is provided the call will return all items until that date/time.

RoomID
- Integer, Required, Sample: 1234
The room ID number to list items for.
If not provided all account classrooms will be included in the result.

 

Sample Call

https://api30.school-network.net/recordings/list/?cid=12345&token=29f4c40b-7de5-4594-afc4-abd07128913d&StartDateTimeUTC=8/6/2016&EndDateTimeUTC=10/8/2016&RoomId=1093

 

Sample Result

<Recordings>
    <Count>2</Count>
    <CompanyId>1</CompanyId>
    <UTCFromDateTime>8/6/2016</UTCFromDateTime>
    <UTCToDateTime>10/8/2016</UTCToDateTime>
    <Items>
        <Item>
            <Id>322818</Id>
            <RecordingName>New Recording</RecordingName>
            <UTCRecordDateTime>8/6/2016 3:45 PM</UTCRecordDateTime>
            <DurationSeconds>20</DurationSeconds>
            <FileSizeBytes>6182</FileSizeBytes>
            <RoomId>1000</RoomId>
            <RecorderUserId>219418</RecorderUserId>
            <PlayBackURL>https://www.school-network.net/E/?url=http://urirec.school-network.net/1/U1703511R1000S5147583.el8</PlayBackURL>
            <DownloadURL>http://urirec.school-network.net/1/U1703511R1000S5147583.el8</DownloadURL>
        </Item>
        <Item>
            <Id>331609</Id>
            <RecordingName>New Recording</RecordingName>
            <UTCRecordDateTime>10/3/2016 2:35 PM</UTCRecordDateTime>
            <DurationSeconds>7</DurationSeconds>
            <FileSizeBytes>6160</FileSizeBytes>
            <RoomId>1000</RoomId>
            <RecorderUserId>219418</RecorderUserId>
            <PlayBackURL>https://www.school-network.net/E/?url=http://urirec.school-network.net/1/U1779410R1000S1776030713.el8</PlayBackURL>
            <DownloadURL>http://urirec.school-network.net/1/U1779410R1000S1776030713.el8</DownloadURL>
        </Item>
    </Items>
</Recordings>

The call will return an XML result set. Each item (recording) is in a separate <item> node.

With this call obtain obtain one or more recordings which took place during a specific live event. To do this you have to provide the proper Room ID parameter as well as the starting/ending time of the live event as parameters to the call.

 


Also In This Category


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

Thank you for your feedback!


Details
Last Modified: 3 Months Ago
Last Modified By: Administrator
Type: INFO
Rated 1 star based on 1 vote
Article has been viewed 303 times.
Options