SAP Litmos Support

Getting Started
Knowledgebase
Community

Articles in this section

See more

Date Range Delta Queries

Avatar
Steve Cunha
  • Updated
Follow

The API's documented here will return a list of records that have been created or updated within a given date range. As such, there is a mandatory date-time parameter that must be used with these delta queries. The "&since=[DATE]&to=[DATE]" parameter is required for each of these delta API's.

 

Important Notes: When using the "since" and "to" date range parameters in the request URI, the date formats adhere to the standard date=time format 'YYYY-MM-DDTHH:MM:SS'. This will return all records that were created/updated between the dates specified. The date range must be equal or less than 7 days.

In an attempt to get results for the current day, the "to" date must be set to a future date to return results successfully.

By default, all API responses will return 100 results. You can return up to 1,000 records by adding the 'limit' query parameter to your URI. Please visit our 'Overview Developer API' documentation and refer to the 'Search & Paging Parameters' section for pagination, and other query parameters you can use. 

 

Get User Details 

Returns a list of people including 'active' and 'inactive' people that have been created or updated within a given date range.

Request Uri:

GET /org/users/details?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Users>
 <User>
 <Id></Id>
 <UserName></UserName>
 <FirstName></FirstName>
 <LastName></LastName>
 <FullName></FullName>
 <Email></Email>
 <AccessLevel></AccessLevel>
 <DisableMessages></DisableMessages>
 <Active></Active>
 <Skype i:nil="true"/>
 <PhoneWork></PhoneWork>
 <PhoneMobile i:nil="true"/>
 <LastLogin/>
 <LoginKey></LoginKey>
 <IsCustomUsername></IsCustomUsername>
 <TimeZone></TimeZone>
 <SalesforceId i:nil="true"/>
 <OriginalId></OriginalId>
 <Street1></Street1>
 <Street2 i:nil="true"/>
 <City></City>
 <State></State>
 <PostalCode></PostalCode>
 <Country></Country>
 <CompanyName i:nil="true"/>
 <JobTitle></JobTitle>
 <CustomField1 i:nil="true"/>
 <CustomField2 i:nil="true"/>
 <CustomField3 i:nil="true"/>
 <Culture></Culture>
 <CustomField4 i:nil="true"/>
 <CustomField5 i:nil="true"/>
 <CustomField6 i:nil="true"/>
 <CustomField7 i:nil="true"/>
 <CustomField8 i:nil="true"/>
 <CustomField9 i:nil="true"/>
 <CustomField10 i:nil="true"/>
 <SalesforceContactId i:nil="true"/>
 <SalesforceAccountId i:nil="true"/>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 <Brand></Brand>
 <ManagerId></ManagerId>
 <ManagerName/>
 <EnableTextNotification></EnableTextNotification>
 <Website/>
 <Twitter/>
 <ExpirationDate/>
 <ExternalEmployeeId i:nil="true"/>
 </User>
 <User>
 ..........
 </User>
</Users>

 

Get User Logins 

Returns a list of people including 'active' and 'inactive' people that have logged into the application within a given date range.

Request Uri:

GET /org/users/logins?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Users xmlns:i="http://www.w3.org/2001/XMLSchema-instance">     
 <User>         
  <Id></Id>         
  <UserName></UserName>         
  <FirstName></FirstName>         
  <LastName></LastName>         
  <FullName></FullName>         
  <Email></Email>         
  <AccessLevel i:nil="true"/>         
  <DisableMessages>true/false</DisableMessages>         
  <Active>true/false</Active>         
  <Skype i:nil="true"/>         
  <PhoneWork i:nil="true"/>         
  <PhoneMobile i:nil="true"/>         
  <LastLogin></LastLogin>         
  <LoginKey>/login.aspx?loginkey=</LoginKey>         
  <IsCustomUsername>true/false</IsCustomUsername>         
  <TimeZone i:nil="true"/>         
  <SalesforceId i:nil="true"/>         
  <OriginalUserId></OriginalUserId>         
  <Street1 i:nil="true"/>         
  <Street2 i:nil="true"/>         
  <City i:nil="true"/>         
  <State i:nil="true"/>         
  <PostalCode i:nil="true"/>         
  <Country i:nil="true"/>         
  <CompanyName></CompanyName>         
  <JobTitle></JobTitle>         
  <CustomField1 i:nil="true"/>         
  <CustomField2 i:nil="true"/>         
  <CustomField3 i:nil="true"/>         
  <Culture i:nil="true"/>         
  <CustomField4 i:nil="true"/>         
  <CustomField5 i:nil="true"/>         
  <CustomField6 i:nil="true"/>         
  <CustomField7 i:nil="true"/>         
  <CustomField8 i:nil="true"/>         
  <CustomField9 i:nil="true"/>         
  <CustomField10 i:nil="true"/>        
  <SalesforceContactId i:nil="true"/>         
  <SalesforceAccountId i:nil="true"/>         
  <CreatedDate i:nil="true"/>         
  <UpdatedDate i:nil="true"/>         
  <CreatedBy>0</CreatedBy>         
  <UpdatedBy>0</UpdatedBy>         
  <Brand i:nil="true"/>         
  <ManagerId>0</ManagerId>         
  <ManagerName/>         
  <EnableTextNotification>true/false</EnableTextNotification>         
  <Website/>         
  <Twitter/>         
  <ExpirationDate/>
  <ExternalEmployeeId i:nil="true"/>     
 </User> 
</Users>

 

Get Modules Results

Module results API will return the list of all user module results that have changed within a given date range.

Request Uri:

GET /org/modules/results?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<ModuleResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <ModuleResult>
  <Id></Id>
  <UserId></UserId>
  <OrginalModuleId></OrginalModuleId>
  <OriginalUserId></OriginalUserId>
  <Name></Name>
  <UserName></UserName>
  <Passmark></Passmark>
  <Active>true/false</Active>
  <Score></Score>
  <Completed></Completed>
  <AttemptNumber></AttemptNumber>
  <CreatedBy></CreatedBy>
  <FinishedDate></FinishedDate>
  <CreatedDate></CreatedDate>
  <StartedDate></StartedDate>
  <TimeTaken></TimeTaken>
  <UpdatedDate></UpdatedDate>
  <Code></Code>
 </ModuleResult>
 .......................
</ModuleResults>

 

Get Course Results

Returns a list of all user course results that have changed within a given date range. You can GET 1000 results using the “limit” parameter.

Request Uri:

GET /org/results/details?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<UserResults>
 <UserResult>
 <UserId></UserId>
 <Id></Id>
 <OriginalUserId></OriginalUserId>
 <OriginalCourseId></OriginalCourseId>
 <Active></Active>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <StartedDate></StartedDate>
 <Completed>true/false</Completed>
 <PercentageComplete></PercentageComplete>
 <CompletedDate></CompletedDate>
 <UpToDate>true/false</UpToDate>
 <Overdue>true/false</Overdue>
 <CompliantTillDate i:nil="true"/>
 </UserResult>
 <UserResult>
 ..........
 </UserResult>
</UserResults>

 

Get Learning paths Results

Learning paths results API returns the list of all user learning paths results that have changed within a given date range.

Request Uri:

GET /org/learningpaths/results?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<LearningPathResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <LearningPathResult>
  <LearningPathId></LearningPathId>
  <Id></Id>
  <Name></Name>
  <Active>true/false</Active>
  <OriginalUserId></OriginalUserId>
  <OriginalLearningPathId></OriginalLearningPathId>
  <PercentageComplete></PercentageComplete>
  <Completed></Completed>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CompliantTillDate i:nil="true"/>
  <StartDate i:nil="true"/>
  <FinishDate i:nil="true"/>
  <CreatedBy></CreatedBy>
  </LearningPathResult>
  .......................
</LearningPathResults>

 

Get Achievements

Returns a list of all users that have earned achievements within a given date range.

Request Uri:

GET /org/achievements?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Achievements>
 <Achievement>
 <UserId></UserId>
 <Id></Id>
 <OriginalUserId></OriginalUserId>
 <OriginalAchievementId></OriginalAchievementId>
 <Title></Title>
 <Description/>
 <AchievementDate></AchievementDate>
 <CourseId></CourseId>
 <OriginalCourseId></OriginalCourseId>
 <CompliantTillDate i:nil="true"/>
 <Score/>
 <Result></Result>
 <Type></Type>
 <CertificateId></CertificateId>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 </Achievement>
 <Achievement>
 ..........
 </Achievement>
</Achievements>

 

Get Modules 

Returns all the modules in an organization that was created/ updated within a given date range.

Request Uri:

GET /org/modules?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Modules xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <Module>
  <Id></Id>
  <OriginalId></OriginalId>
  <Name></Name>
  <Description></Description>
  <Active>true/false</Active>
  <Passmark></Passmark>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <ModuleType></ModuleType>
  </Module>
  .......................
</Modules>

 

Get Courses

Returns all the courses in your organization that were created or updated within a given date range.

Request Uri:

GET /org/courses?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Courses>
 <Course>
 <Id></Id>
 <Code/>
 <Name></Name>
 <Active></Active>
 <ForSale></ForSale>
 <OriginalCourseId></OriginalCourseId>
 <Description></Description>
 <EcommerceShortDescription></EcommerceShortDescription>
 <EcommerceLongDescription></EcommerceLongDescription>
 <CourseCodeForBulkImport></CourseCodeForBulkImport>
 <Price></Price>
 <AccessTillDate i:nil="true"/>
 <AccessTillDays i:nil="true"/>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 <UpdatedBy></UpdatedBy>
 <CompliantTillDays i:nil="true"/>
 <TimeLimitDate i:nil="true"/>
 <TimeLimitDays>0</TimeLimitDays>
 <DisplayOrder>0</DisplayOrder>
 <IncludeInLibrary>false</IncludeInLibrary>
 <CourseImageURL i:nil="true"/>
 </Course>
 <Course>
 ..........
 </Course>
</Courses>

 

 

Get Learning Paths

Returns all learning paths that were created/updated within a given date range.

Request Uri:

GET /org/learningpaths?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<LearningPaths>
 <LearningPath>
 <Id></Id>
 <Name></Name>
 <Description></Description>
 <Active></Active>
 <OriginalId></OriginalId>
 <ForSale>true/false</ForSale>
 <Price></Price>
 <EcommerceShortDescription/>
 <EcommerceLongDescription/>
 <AccessTillDate i:nil="true"/>
 <AccessTillDays i:nil="true"/>
 <CreatedDate></CreatedDate>
 <UpdatedDate></UpdatedDate>
 <CreatedBy></CreatedBy>
 </LearningPath>
 <LearningPath>
 ..........
 </LearningPath>
</LearningPaths>

 

Get Courses and Modules

Returns all modules under each course within a given date range.

Request Uri:

GET /org/courses/modules?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<CourseModules>
 <CourseModule>
  <CourseId></CourseId>
  <Id></Id>
  <OriginalCourseId></OriginalCourseId>
  <OriginalModuleId></OriginalModuleId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </CourseModule>
 <CourseModule>
 ..........
 </CourseModule>
</CourseModules>

 

Get Courses and Learning Paths

Returns all courses that are assigned to a specific learning path within a given date range.

Request Uri:

GET /org/learningpaths/courses?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<LearningPathCourses>
 <LearningPathCourse>
  <LearningPathId></LearningPathId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <OriginalCourseId></OriginalCourseId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </LearningPathCourse>
 <LearningPathCourse>
  ..........
 </LearningPathCourse>
</LearningPathCourses>

 

Get User Course Assignments

Returns all courses assigned to users within a given date range.

Important Note: It will not return Course assignments through the team.

Request Uri:

GET /org/users/courses?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<UserCourses>
 <UserCourse>
  <UserId></UserId>
  <ID></ID>
  <OriginalUserId></OriginalUserId>
  <OriginalCourseId></OriginalCourseId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </UserCourse>
 <UserCourse>
 ..........
 </UserCourse>
</UserCourses>

 

Get User Learning Path Assignments

Returns all learning-paths assigned to users within a given date range.

Important Note: It will not return learning path assignments through the team.

Request Uri:

GET /org/learningpaths/users?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<LearningPathUsers>
 <LearningPathUser>
  <LearningPathId></LearningPathId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <Active>true/false</Active>
  <OriginalUserId></OriginalUserId>
  <CreatedBy></CreatedBy>
  <CreatedDate></CreatedDate>
  <UpdatedBy></UpdatedBy>
  <UpdatedDate i:nil="true"/>
 </LearningPathUser>
 <LearningPathUser>
 ..........
 </LearningPathUser>
</LearningPathUsers>

 

Get Teams

Returns all teams that were created or modified within a given date range.

Request Uri:

GET /org/teams?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<Teams>
 <Team>
  <Id></Id>
  <Name></Name>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
  <ParentTeamId/>
  <TeamCodeForBulkImport></TeamCodeForBulkImport>
  </Team>
 <Team>
  ..........
 <Team>
</Teams>

 

Get Team Users Assigned

Returns all user team assignments that were created or modified within a given date range. 

Request Uri:

GET /org/teams/users?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<TeamUsers>
 <TeamUser>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalTeamId></OriginalTeamId>
  <OriginalUserId></OriginalUserId>
  <Active>true/false</Active>
  <IsTeamLeader>true/false</IsTeamLeader>
  <IsTeamAdmin>true/false</IsTeamAdmin>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamUser>
 <TeamUser>
 ..........
 </TeamUser>
</TeamUsers>

 

Get Team Courses Assigned

Returns all team course assignments that were created or modified within a given date range. 

Request Uri:

GET /org/teams/courses?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<TeamCourses>
 <TeamCourse>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalCourseId></OriginalCourseId>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <IsInTeamLibrary>true/false</IsInTeamLibrary>
  <CreatedDate></CreatedDate>
  <UpdatedDate></UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamCourse>
 <TeamCourse>
 ..........
 </TeamCourse>
</TeamCourses>

 

Get Team Learning Paths Assigned

Returns all team learning-paths that were created or modified within a given date range. 

Request Uri:

GET /org/teams/learningpaths?source={source}&since=[YYYY-MM-DD HH:MM:SS]&to=[YYYY-MM-DD HH:MM:SS]

 

Response Body: (XML)

<TeamLearningPaths>
 <TeamLearningPath>
  <TeamId></TeamId>
  <Id></Id>
  <OriginalLearningPathId></OriginalLearningPathId>
  <OriginalTeamId></OriginalTeamId>
  <Active>true/false</Active>
  <IsInTeamLibrary>true/false</IsInTeamLibrary>
  <CreatedDate></CreatedDate>
  <UpdatedDate>3</UpdatedDate>
  <CreatedBy></CreatedBy>
  <UpdatedBy></UpdatedBy>
 </TeamLearningPath>
 <TeamLearningPath>
 ..........
 </TeamLearningPath>
</TeamLearningPaths>

Related articles

Comments

0 comments

Article is closed for comments.