Download presentation
Presentation is loading. Please wait.
Published byLetitia Lewis Modified over 8 years ago
1
© ELEARNINGFORCE International, 2015 LMS365 ® OData overview
2
Open Data Protocol Open Data Protocol (OData) is an open protocol to allow the creation and consumption of queryable and interoperable RESTful APIs in a simple and standard way. It's initiated by Microsoft in year 2007.ODataRESTful Big ecosystemBig ecosystem of client/server libraries and integrations (can be connected to and etc.)
3
Three Laws of Data Protection Your Data is Yours We provide read-only OData service with available customer’s datasets Your Data is Protected Https only end point https://api.365.systems/odatahttps://api.365.systems/odata Access by API Secret Key (provided by support request) Your Data is Portable You can consume data from any devices and services which support OData
4
Data structure
5
DATA structure description CourseCatalogs sequence of all actual course catalogs from tenant Courses sequence of all actual courses from tenant CourseCompletionStatuses sequence of all course completion info from tenant Teachers/Learners sequence of actual users with specific role in any course on tenant Users sequence of users (teacher/learners in past or now) from tenant Courses — sequence of actual (deleted will not be included) courses from catalog Teachers — sequence of active user with teacher role on course Learners — sequence of active user with learner role on course) CourseCompletionStatuses — sequence of completion status for course (not active/deleted user will NOT be included) Scorms — sequence of SCORM packages selected on course LearningPaths — sequence of Learning Paths created on course
6
DATA structure description Scorms sequence of all actual SCORM packages from tenant ScormAttempts sequence of all actual SCORM attempts from tenant ScormUserStatus sequence of all actual SCORM statuses from tenant
7
DATA structure description LearningPaths sequence of all actual learning modules from tenant LearningPathAttempts sequence of all actual learning modules attempts from tenant LearningPathUserStatuses sequence of all actual learning modules statuses from tenant Note: The Learning Path Add-In has been renamed to Learning Module Builder Add-in
8
DATA structure description All request for entities do not support $expand of related entities ~/Courses/?$expand=… not supported All request for entity by primary key will expand related entities by default ~/Courses(SiteId=guid‘...’, WebId=guid‘…’) EntityPrimary Key CourseCatalog SiteId, WebId Course CourseCompletionStat us SiteId, WebId, UserLoginName Teacher Learner UserLoginName
9
Example of usage Create connection to OData service in Excel
10
Configure relationships
11
Final relationships
12
Create relationships
19
Code snippet Use any type of OData library even if code generation by Service Reference http://www.odata.org/libraries/
20
Code snippet example how to get course related infos from course catalog https://gist.github.com/shapel/1fd09a34d 8d56b8683c3
21
LMS365 API Authentication *Intended to use from SharePoint Online pages only Authentication ways to use LMS365 OData API Basic authentication using API key Authenticating using the Authorization Header*
22
When can you use it? Global reports for Excel or PowerBI My Application needs data from whole LMS365 tenant Basic authentication using API key
23
When can you use it? Your Application is JavaScript based app runs on SharePoint Online pages Your Application needs LMS365 data of logged in user only Your application needs to Enroll/Unenroll current logged in user Authenticating using the Authorization Header
24
Code snippet Authenticating using the Authorization Header: Basic usage Paste the following here: LMS365 Auth Library Your JavaScript App
25
Code snippet Authenticating using the Authorization Header: Enroll current user to a course
Similar presentations
© 2025 SlidePlayer.com Inc.
All rights reserved.