Menu

Search

Electa Live Virtual Classroom, LMS - Help & Support Portal


API 3.0 - Session Logs


Administrator
API 3.0

This API call returns the session log entries for a time frame, for a selected virtual classroom or user.

Call: <API_URL>/logs/
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 the logs for the current date.
If only Start date is specified the call will return the logs for the 24 hours following the specified date/time

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

UserId - Integer, Optional, Sample: 22329843
The number if of the user to display attendance for

Username - String, Optional, Sample: johnsmith
The username of the user whose logs will be displayed

The above three parameters are not required but at least one has to be present.


 

Sample Call

https://api30.school-network.net/logs/?cid=12345&token=29f4c40b-7de5-4594-afc4-abd07128913d&StartDateTimeUTC=1/14/2016&EndDateTimeUTC=1/20/2016&RoomId=1093

 

Sample Result

<Logs>
    <Count>2</Count>
    <CompanyId>12345</CompanyId>
    <UTCFromDateTime>1/14/2016</UTCFromDateTime>
    <UTCToDateTime>1/20/2016</UTCToDateTime>
    <Items>
         <Item>
              <UserId>219418</UserId>
              <ExternaName/>
              <RoomID>1000</RoomID>
              <DisplayName>Daniel Miller</DisplayName>
              <UTCIn>1/14/2016 7:22 AM</UTCIn>
              <UTCOut>1/14/2016 7:22 AM</UTCOut>
              <IPAddress>xxx.xxx.135.6</IPAddress>
              <AccessLevel>ADM</AccessLevel>
         </Item>
         <Item>
              <UserId>219418</UserId>
              <ExternaName/>
              <RoomID>1000</RoomID>
              <DisplayName>Daniel Miller</DisplayName>
              <UTCIn>1/18/2016 8:19 PM</UTCIn>
              <UTCOut>1/18/2016 8:25 PM</UTCOut>
              <IPAddress>xxx.xxx.128.11</IPAddress>
              <AccessLevel>ADM</AccessLevel>
         </Item>
    </Items>
</Logs>

 

Results Explained

UserId - the internal numeric user id of the attendee
ExternalName - username of the attendee if created by an API call to the Direct Classroom Namespace
RoomId - the numeric Id of the virtual classroom
DisplayName - the name of the user as viewed during the live session
UTCIn, UTCOut - the date and time of the entry/exit in UTC. If UTCOut is empty then the user is still in session.
IPAddress - the network IPv4 address of the user
AccessLevel - the access level of the user in the session. ADM stay for administrator, STD stays for Student and MDR stays for Moderator.


Also In This Category


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

Thank you for your feedback!


Details
Last Modified: 5 Months Ago
Last Modified By: Administrator
Type: INFO
Article not rated yet.
Article has been viewed 411 times.
Options