SAP Litmos Support

Getting Started
Knowledgebase
Community

Articles in this section

See more

Instructor Led Training

Avatar
Madeline
  • Updated
Follow

Get Future Session List

Returns a list of sessions in the future for an organisation. By default the first 100 sessions are returned. The list can be filtered on session name and sorted by session’s start date. It can also be paged using the optional paging parameters.

AccessLevel: Account Owners/Administrators Only

Request Uri

GET /sessions/future

https://api.litmos.com/v1.svc/sessions/future?source={source}

Note: API key passed in header 

Important Note: This request supports the use of the parameter, "&since=[DATE]&to=[DATE]". It is not a mandatory parameter.

https://api.litmos.com/v1.svc/sessions/future?source={source}&since=[DATE]&to=[DATE]

When using the "since" and "to" date range parameters in the request URI, the date range format must be 'YYYY-MM-DD HH: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 order to get the results for the current day, the "to" date must be set to a future date to return results successfully.

Response

Returns HTTP status code 200 on success and the session list in the response body.

<SessionCourses>
    <SessionCourse>
        <Id></Id>
        <Code/>
        <Name></Name>
        <Description/>
        <Active>true/false</Active>
        <ForSale></ForSale>
        <OriginalId></OriginalId>
        <Price></Price>
        <Modules>
            <SessionModule>
                <Id></Id>
                <Code/>
                <Name></Name>
                <Description/>
                <Sessions>
                    <Session>
                        <Id></Id>
                        <Name></Name>
                        <InstructorUserId></InstructorUserId>
                        <InstructorName></InstructorName>
                        <SessionType></SessionType>
                        <Days>
                            <SessionDay>
                                <Id></Id>
                                <StartDate></StartDate>
                                <EndDate></EndDate>
                                <StartTime></StartTime>
                                <EndTime></EndTime>
                                <SendReminder></SendReminder>
                                <ReminderValue></ReminderValue>
                                <ReminderMetric></ReminderMetric>
                            </SessionDay>
                        </Days>
                        <TimeZone></TimeZone>
                        <Location/>
                        <LocationId></LocationId>
                        <ResourceId></ResourceId>
                        <Resources></Resources>
                        <StartDate></StartDate>
                        <EndDate></EndDate>
                        <CourseName></CourseName>
                        <ModuleName></ModuleName>
                        <Slots/>
                        <Accepted></Accepted>
                        <EnableWaitList></EnableWaitList>
                        <Details></Details>
                    </Session>
                </Sessions>
            </SessionModule>
        </Modules>
    </SessionCourse>
</SessionCourses>

 

Get Past Session List

Returns a list of sessions from the past for an organisation. By default the first 100 sessions are returned. The list can be filtered on session name and sorted by session’s start date. It can also be paged using the optional paging parameters.

AccessLevel: Account Owners/Administrators Only

Request Uri

GET /sessions/past

https://api.litmos.com/v1.svc/sessions/past?source={source}

Note: API key passed in header 

Response

Returns HTTP status code 200 on success and the session list in the response body

 

Register User to Session

Register a user to a session given the user’s Id.

AccessLevel: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

POST /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}/users/{userId}/register

Responseget session list

Returns a HTTP status code 200 on success.

 

Get ILT Modules in a Course

Returns a list of ILT Modules given a course Id.

AccessLevel: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /courses/{courseId}/modules/ilt

Response

<Modules>
   <Module>
       <Id>string [max length 50]</Id>
       <Code>string [max length 20]</Code>
       <Name>string [max length 255]</Name>
       <Description>string [max length 2000]</Description>
   <Module>
</Modules>

 

Get Session List in a Module

Returns a session list given a module Id. For a single Instructor session, the Instructor UserId and the Instructor username will show the ID and the Name of that instructor, however for a Multi-instructor led session, the Instructor userId will be 0 and the Instructor name will be Multiple Instructors.

AccessLevel: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /courses/{courseId}/modules/{moduleId}/sessions

Response

<Sessions>
 <Session>
   <Id>string [max length 50]</Id>
   <Name>string [max length 100]</Name>
   <InstructorUserId>string [max length 50]</InstructorUserId>
   <InstructorName>string [optional, max length 100]</InstructorName>
   <SessionType>string [1, 2, 3, or 4]</SessionType>
   <Days>
          <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
   </Days>
   <TimeZone>string [optional, max length 100]</TimeZone>
   <Location>string [optional, max length 1000]</Location>
   <LocationId>string [optional, max 50]</LocationId>
   <ResourceId>integer[optional, max 50]</ResourceId>
   <Resources>string [optional, max length 100]</Resources>
   <StartDate>string [optional, max length]</StartDate>
   <EndDate>string [optional, max length]</EndDate>
   <CourseName>string [optional, max length 255]</ CourseName>
   <ModuleName>string [optional, max length 255]</ModuleName>
   <Slots>string [optional, max length 50]</Slots>
   <Accepted>string [optional, max length 50]</Accepted>
   <EnableWaitList>true/false</EnableWaitList>
   <Details></Details>
 </Session>
<Sessions>

 

Get Session

Returns a single session in an ILT module for a given session Id and module Id.

AccessLevel: Super Admins/Account Owners/Administrators Only

Request Uri

GET /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}

Response

<Session>
   <Id>string [max length 50]</Id>
   <Name>string [max length 100]</Name>
   <InstructorUserId>string [max length 50]</InstructorUserId>
   <InstructorName>string [optional, max length 100]</InstructorName>
   <SessionType>string [1, 2, 3, or 4]</SessionType >
   <Days>
          <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
   </Days>
   <TimeZone>string [optional, max length 100]</TimeZone>
   <Location>string [optional, max length 1000]</Location>
   <LocationId>string [optional, max 50]</LocationId>
   <ResourceId>integer[optional, max 50]</ResourceId>
   <Resources>string [optional, max length 100]</Resources>
   <StartDate>string [optional, max length]</StartDate>
   <EndDate>string [optional, max length]</EndDate>
   <CourseName>string [optional, max length 255]</ CourseName>
   <ModuleName>string [optional, max length 255]</ModuleName>
   <Slots>string [optional, max length 50]</Slots>
   <Accepted>string [optional, max length 50]</Accepted>
   <EnableWaitList>true/false</EnableWaitList>
   <Details></Details>
</Session>

 

Get Instructor List

Returns a list of instructors.

AccessLevel: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /instructors

Response

Returns HTTP status code 200 on success and the team in the response body

<Users>
   <User>
    <Id>string [max length 50]</Id>
    <UserName> string [max length 255]</UserName>
    <FirstName> string [max length 100]</FirstName>
    <LastName> string [max length 100]</LastName>
   </User>
</Users>

 

Get Session List for an Instructor

Returns a list of sessions for a given instructor Id.

AccessLevel: Account Owners/Administrators Only

Request Uri

GET /instructors/{instructorId}/sessions

Response

Returns HTTP status code 200 on success and the team in the response body

<SessionCourses>
<SessionCourse>
   <Id>string [max length 50]</Id>
   <Code>string [max length 20]</Code>
   <Name>string [max length 255]</Name>
   <Description>string [optional, max length 2000]</Description>
   <Active>true/false</Active>
   <ForSale>true/false</ForSale>
   <OriginalId>string [max length 50]</OriginalId>
   <Price></Price>
   <Modules>
       <SessionModule>
     <Id>string [max length 50]</Id>
     <Code>string [max length 20]</Code>
     <Name>string [max length 255]</Name>
     <Description>string [optional, max length 2000]</Description>
<Sessions>
<Session>
   <Id>string [max length 50]</Id>
   <Name>string [max length 100]</Name>
   <InstructorUserId>string [max length 50]</InstructorUserId>
   <InstructorName>string [optional, max length 100]</InstructorName>
   <SessionType>string [1, 2, 3, or 4]</SessionType>
   <Days>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
   </Days>
   <TimeZone>string [optional, max length 100]</TimeZone>
   <Location>string [optional, max length 1000]</Location>
   <LocationId>string [optional, max 50]</LocationId>
   <ResourceId>integer[optional, max 50]</ResourceId>
   <Resources>string [optional, max length 100]</Resources>
   <StartDate>string [optional, max length]</StartDate>
   <EndDate>string [optional, max length]</EndDate>
   <CourseName>string [optional, max length 255]</ CourseName>
   <ModuleName>string [optional, max length 255]</ModuleName>
   <Slots>string [optional, max length 50]</Slots>
   <Accepted>string [optional, max length 50]</Accepted>
   <EnableWaitList>true/false</EnableWaitList>
   <Details></Details>
</Session>
     </Sessions>
         </SessionModule>
   </Modules>
</SessionCourse>
</SessionCourses>

 

Create Session

Creates a new session in an ILT module.  Supports Class Room, Webinar, Webex Training sessions.

AccessLevel: Super Admins/Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

POST /courses/{courseId}/modules/{moduleId}/sessions

Request Body

<Session>
   <Id>string [max length 50]</Id>
   <Name>string [max length 100]</Name>
   <InstructorUserId>string [max length 50]</InstructorUserId>
   <InstructorName>string [optional, max length 100]</InstructorName>
   <SessionType>string [1, 2, 3, or 4]</SessionType>
   <Days>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</StartTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</StartTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
   </Days>
   <TimeZone>string [optional, max length 100]</TimeZone>
   <Location>string [optional, max length 1000]</Location>
   <LocationId>string [optional, max 50]</LocationId>
   <StartDate>string [optional, max length]</StartDate>
   <EndDate>string [optional, max length]</EndDate>
   <Slots>string [optional, max length 50]</Slots>
   <Accepted>string [optional, max length 50]</Accepted>
   <EnableWaitList>true/false</EnableWaitList>
   <Details></Details>
</Session>

Response

Returns a HTTP status code 200 on success.

 

Update Session

Update a single session in an ILT module. Supports Class Room, Webinar, Webex Training sessions. The session Id in the Uri must match the Id specified in the request body. The session Id in the Uri and the session Id in the request body must match.

AccessLevel: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

PUT /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}

Request Body

<Session>
   <Id>string [max length 50]</Id>
   <Name>string [max length 100]</Name>
   <InstructorUserId>string [max length 50]</InstructorUserId>
   <InstructorName>string [optional, max length 100]</InstructorName>
   <SessionType>string [1, 2, 3, or 4]</SessionType>
   <TimeZone>string [optional, max length 100]</TimeZone>
   <Location>string [optional, max length 1000]</Location>
   <LocationId>string [optional, max 50]</LocationId>
   <Days>
           <SessionDay>
                <Id>string [max length 50]</Id>
                <StartDate>string [max length]</StartDate>
                <EndDate>string [max length]</EndDate>
                <StartTime>string [max length]</EndTime>
                <EndTime>string [max length]</EndTime>
                <SendReminder>true/false</SendReminder>
                <ReminderValue>string [max length 50]</ReminderValue>
                <ReminderMetric>string [max length 100]</ReminderMetric>
           </SessionDay>
   </Days>
   <StartDate>string [optional, max length]</StartDate>
   <EndDate>string [optional, max length]</EndDate>
   <CourseName>string [optional, max length 255]</ CourseName>
   <ModuleName>string [optional, max length 255]</ModuleName>
   <Slots>string [optional, max length 50]</Slots>
   <Accepted>string [optional, max length 50]</Accepted>
   <EnableWaitList>true/false</EnableWaitList>
   <Details></Details>
</Session>

Response

Returns a HTTP status code 200 on success

 

Get Session Roll Call

Returns a list of users registered to a session for a given session Id.

Access Level: Super Admins/Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}/rollcall

Response

<EventUsers>
   <EventUser>
    <EventStatus>string [max length 50]</Id>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Completed>ignored</Completed>
   </ EventUser >
   < EventUser >
       <EventStatus>string [max length 50]</Id>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Completed>ignored</Completed>
   </ EventUser >
</ EventUsers >

 

Mark Session complete and add score

Updates a list of users registered to a session for a given session Id.

Access Level: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

POST /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}/rollcall

Request Body

<EventUsers>
   <EventUser>
     <Id>String [Must match user registered for the event]</Id>
     <EventStatus>[ignored]</EventStatus>
     <FirstName>ignored</FirstName>
     <LastName>ignored</LastName>
     <Email>ignored</Email>
     <CompanyName>ignored</CompanyName>
     <Score>int</Score>
     <Completed>true/false</Completed>
   </EventUser>
   <EventUser>
     <Id>String [Must match user registered for the event]</Id>
     <EventStatus>[ignored]</EventStatus>
     <FirstName>ignored</FirstName>
     <LastName>ignored</LastName>
     <Email>ignored</Email>
     <CompanyName>ignored</CompanyName>
     <Score>int</Score>
     <Completed>true/false</Completed>
   </EventUser>
</ EventUsers >

 

Get ILT Module Assignments

Returns a list of users assigned to an ILT Module a given module Id.

Access Level: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /courses/{courseId}/modules/{moduleId}/registration

Response

<EventUsers>
   <EventUser>
    <Id>string [max length 50]</Id>
    <EventStatus>[ignored]</EventStatus>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Completed>ignored</Completed>
   </EventUser>
   <EventUser>
    <Id>string [max length 50]</Id>
    <EventStatus>[ignored]</EventStatus>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Completed>ignored</Completed>
   </EventUser>
</ EventUsers>

 

Delete a Session

Delete a given session.

Access Level: Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

DELETE /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}

Response

Returns a HTTP status code 200 on success

 

Get Attendance

Returns a list of users registered to a session for a given session Id.

Access Level: Super Admins/Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

GET /courses/{courseId}/modules/{moduleId}/sessions/{sessionId}/attendance

Response

<EventUsers>
   <EventUser>
    <Id>string [max length 50]</Id>
    <EventStatus>ignored</EventStatus>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Score>Integer</Score>
    <Completed>ignored</Completed>
   </EventUser>
   <EventUser>
    <Id>string [max length 50]</Id>
    <EventStatus>ignored</EventStatus>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
    <Email>ignored</Email>
    <CompanyName>ignored</ CompanyName>
    <Score>Integer</Score>
    <Completed>ignored</Completed>
   </EventUser>
</EventUsers>

 

Mark Attendance

Mark attendance of session day.

Access Level: Super Admins/Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

POST /courses/{courseId}/modules/{moduleId}/sessiondays/{sessionDayId}/users/{userId}/attended/{attended}

Response

Returns a HTTP status code 200 on success

 

Mark Attendance of User List

Mark attendance of session day given a user list.

Access Level: Super Admins/Account Owners/Administrators/Team Admins/Team Leaders Only

Request Uri

POST /courses/{courseId}/modules/{moduleId}/sessiondays/{sessionDayId}/attended/{attended}

Request Body

<Users>
   <User>
    <Id>string [max length 50]</Id>
    <UserName>ignored</UserName>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
   </User>
   <User>
    <Id>string [max length 50]</Id>
    <UserName>ignored</UserName>
    <FirstName>ignored</FirstName>
    <LastName>ignored</LastName>
   </User>
</Users>

Response

Returns a HTTP status code 200 on success

Related articles

Comments

0 comments

Article is closed for comments.