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 API paths.

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-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 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. See the Search & Paging Parameters section for pagination and other query parameters you can use.

Get Ecommerce Courses

Get a list of courses enabled for ecommerce that have been created or updated within a given date range.

Request URI

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

Response Body (XML)

<Ecommerce xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Courses>
        <Course>
            <Id>string [max length 50]</Id>
            <Code>string [max length 50]</Code>
            <Name>string [max length 255]</Name>
            <Active>true/false</Active>
            <UpdatedBy>string [max length 50]</UpdatedBy>
            <OriginalId>string [max length 50]</OriginalId>
            <Description/>
            <EcommerceShortDescription/>
            <EcommerceLongDescription/>
            <Skills/>
            <Price>integer</Price>
            <AccessTillDate>YYYY-MM-DDTHH:MM:SS</AccessTillDate>
            <AccessTillDays>YYYY-MM-DDTHH:MM:SS</AccessTillDays>
            <CoursePrerequisites/>
            <LearningPathPrerequisites/>
            <Currency>AlphaCode</Currency>
            <Languages/>
            <Topics/>
            <Tags/>
            <CreatedDate>YYYY-MM-DDTHH:MM:SS</CreatedDate>
            <UpdatedDate>YYYY-MM-DDTHH:MM:SS</UpdatedDate>
            <CreatedBy>string [max length 50]</CreatedBy>
        </Course>
    </Courses>
</Ecommerce>

Get Ecommerce Course ILT Sessions

Get a list of courses enabled for ecommerce with future ILT sessions that have been created or updated within a given date range.

Request URI

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

Response Body (XML)

<Ecommerce xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <SessionCourses>
        <SessionCourse>
            <Id>string [max length 50]</Id>
            <Code>string [max length 50]</Code>
            <Name>string [max length 225]</Name>
            <Active>true/false</Active>
            <OriginalId>string [max length 50]</OriginalId>
            <Description>string</Description>
            <Price>integer</Price>
            <Currency>AlphaCode</Currency>
            <Modules>
                <Module>
                    <Id>string [max length 50]</Id>
                    <Code>string [max length 50]</Code>
                    <Name>string [max length 225]</Name>
                    <OriginalId>string [max length 50]</OriginalId>
                    <Description>string</Description>
                    <Sessions>
                        <Session>
                            <Id>string [max length 50]</Id>
                            <Name>string [max length 225]</Name>
                            <SessionType>integer</SessionType>
                            <TimeZone>UTC</TimeZone>
                            <StartDate>YYYY-MM-DDTHH:MM:SS</StartDate>
                            <EndDate>YYYY-MM-DDTHH:MM:SS</EndDate>
                            <Accepted>integer</Accepted>
                            <EnableWaitList>true/false</EnableWaitList>
                            <CloseRegBeforeStartDays>integer</CloseRegBeforeStartDays>
                            <CloseUnRegBeforeStartDays>inteer</CloseUnRegBeforeStartDays>
                            <Days>
                                <Day>
                                    <Id>string [max length 50]</Id>
                                    <StartDate>YYYY-MM-DDTHH:MM:SS</StartDate>
                                    <EndDate>YYYY-MM-DDTHH:MM:SS</EndDate>
                                    <StartTime>HH:MM:SS</StartTime>
                                    <EndTime>HH:MM:SS</EndTime>
                                    <SendReminder>true/false</SendReminder>
                                    <ReminderValue>integer</ReminderValue>
                                    <ReminderMetric>minutes</ReminderMetric>
                                    <Instructors
                                            xmlns:a="http://schemas.datacontract.org/2004/07/LitmosService.Public.Resources">
                                        <EcommerceSessionInstructor>
                                            <a:Id>string [max length 50]</a:Id>
                                            <a:Name>string [max length 255]</a:Name>
                                        </EcommerceSessionInstructor>
                                    </Instructors>
                                    <Location>string [max length 100]</Location>
                                    <LocationId>integer</LocationId>
                                    <Slots>integer</Slots>
                                    <MinimumSlots>integer</MinimumSlots>
                                    <Details i:nil="true"/>
                                    <Resources
                                            xmlns:a="http://schemas.datacontract.org/2004/07/LitmosService.Public.Resources"/>
                                </Day>
                            </Days>
                        </Session>
                    </Sessions>
                </Module>
            </Modules>
        </SessionCourse>
    </SessionCourses>
</Ecommerce>

Get Ecommerce Learning Paths

Get a list of learning paths enabled for ecommerce that have been created or updated within a given date range.

Request URI

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

Response Body (XML)

<Ecommerce xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <LearningPaths>
        <LearningPath>
            <Id>string [max length 50]</Id>
            <Name>string [max length 255]</Name>
            <Description/>
            <Active>true/false</Active>
            <OriginalId>string [max length 50]</OriginalId>
            <Price>integer</Price>
            <EcommerceShortDescription/>
            <EcommerceLongDescription/>
            <AccessTillDate>YYYY-MM-DDTHH:MM:SS</AccessTillDate>
            <AccessTillDays>YYYY-MM-DDTHH:MM:SS</AccessTillDays>
            <CreatedDate>YYYY-MM-DDTHH:MM:SS</CreatedDate>
            <UpdatedDate>YYYY-MM-DDTHH:MM:SS</UpdatedDate>
            <CreatedBy>string [max length 50]</CreatedBy>
            <Code>string [max length 50]</Code>
            <Currency>AlphaCode</Currency>
            <Languages/>
            <Topics/>
            <Tags/>
            <CoursePrerequisites/>
            <LearningPathPrerequisites/>
            <Skills/>
            <UpdatedBy i:nil="true"/>
        </LearningPath>
    </LearningPaths>
</Ecommerce>