• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Documentation

APIs

Home › Litmos Documentation › Collections & Collection Listings Via API

Collections & Collection Listings Via API

The Collections feature provides an easy way to create, distribute and manage bundles of training. Each Collection is distributed through an entitlement record, called a Collection “Listing”. A Collection can contain Assets, Courses and Learning Paths.

The Collection listing specifies who can access the Collection, how long those users can access the Collection, and the maximum number of users who can consume that Collection.

The API’s documented here are for the Collections feature in Litmos.

Create a Collection

Creates a new Collection. A collection will contain content and the content will be distributed via Collection Listings.

Request URI

POST /collections?source={source}

Request Body

<Collection>
    <Name></Name>
    <Description></Description>
    <DefaultListing>true/false</DefaultListing>
    <ImageURL></ImageURL>
</Collection>

Response Body

<Collection xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Id></Id>
    <Name></Name>
    <Description></Description>
    <DefaultListing>true/false</DefaultListing>
    <ImageURL i:nil="true"/>
</Collection>

Delete a Collection

Deletes a Collection. A collection contains content and the content will be distributed via a Collection Listing. The Collection cannot be deleted if it has a Collection Listing assigned. You will get a 403 error if a listing is assigned.

Request URI

DELETE /collections/{collectionid}?source={source}

Response Header

200 ok

Add Courses to a Collection

Add course records to a collection. A collection will contain content and the content will be distributed via Collection Listings.

Request URI

POST /collections/{collectionid}/courses?source={source}

Request Body

<Courses>
    <Course>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </Course>
    <Course>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </Course>
</Courses>

Response Header

201 Created

Remove a Course from a Collection

Remove a course record from a collection. A collection will contain content and the content will be distributed via Collection Listings.

Request URI

DELETE /collections/{collectionid}/courses?source={source}

Request Body

<Courses>
    <Course>
        <Id>string [max length 50]</Id>
    </Course>
</Courses>

Response Header

200 OK

Add Learning Paths to a Collection

Add learning path records to a collection. A collection will contain content and the content will be distributed via Collection Listings.

Request URI

POST /collections/{collectionid}/learningpaths?source={source}

Request Body

<LearningPaths>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </LearningPath>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </LearningPath>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </LearningPath>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </LearningPath>
    <LearningPath>
        <Id>string [max length 50]</Id>
        <SeqId>string [max length 2]</SeqId>
        (optional)
    </LearningPath>
</LearningPaths>

Response Header

201 Created

Remove a Learning Path from a Collection

Remove a learning path record from a collection. A collection will contain content and the content will be distributed via Collection Listings.

Request URI

DELETE /collections/{collectionid}/learningpath?source={source}

Request Body

<Learningpaths>
    <Learningpath>
        <Id>string [max length 50]</Id>
    </Learningpath>
</Learningpaths>

Response Header

200 OK

Create a Collection Listing

Create a listing entitlement within a collection record.. A listing is an entitlement layer which controls which users and teams can access the Collection under that entitlement, how many total people can access it in the context of that entitlement, and how long it can be accessed for in the context of that entitlement.

Important Note: DurationType value can be “Unlimited”, “Dynamic”, or “Fixed”.

  • FixedDate field will require the value “0” for DurationType “Unlimited”
  • FixedDate field will require the value “n” for DurationType “Dynamic”
  • FixedDate field will require the value “YYYY-MM-DDTHH:MM:SS” for DurationType “Fixed”.

Request URI

POST /collectionlistings?source={source}

Request Body

<Listing>
    <Id></Id>
    <Name></Name>
    <Active></Active>
    <DurationType></DurationType>
    <MaxUsers></MaxUsers>
    <DurationDays></DurationDays>
    <FixedDate></FixedDate>
    <CollectionId>encryptedID</CollectionId>
</Listing>

Response Body

<Listing xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Id></Id>
    <Name></Name>
    <Active></Active>
    <DurationType></DurationType>
    <MaxUsers></MaxUsers>
    <DurationDays></DurationDays>
    <FixedDate></FixedDate>
    <CollectionId></CollectionId>
</Listing>

Delete a Collection Listing

Deletes a Collection Listing. A listing is an entitlement layer which controls which users and teams can access the Collection under that entitlement, how many total people can access it in the context of that entitlement, and how long it can be accessed for in the context of that entitlement. The Collection Listing cannot be deleted if it has any Users or Teams assigned. You will get a 403 error if a User or Team is assigned.

Request URI

DELETE /collectionlistings/{collectionid}/{listingid}?source={source}

Response Header

200 ok

Get a list of Collections

Returns a list of Collections that have been created in the org.

Request URI

GET /collections?source={source}

Response Body

<Collections>
    <Collection>
        <Id></Id>
        <Name></Name>
    </Collection>
    <Collection>
        <Id></Id>
        <Name></Name>
    </Collection>
</Collections>

Get a list of Collection Listings

Get a list of collection listing entitlements that belong to a collection record.

Request URI

GET /collectionlistings/{collectionid}?source={source}

Response Body

<Listings>
    <Listing>
        <Id></Id>
        <Name></Name>
        <Active></Active>
        <DurationType></DurationType>
        <MaxUsers></MaxUsers>
        <DurationDays></DurationDays>
        <FixedDate></FixedDate>
    </Listing>
    <Listing>
        <Id></Id>
        <Name></Name>
        <Active></Active>
        <DurationType></DurationType>
        <MaxUsers></MaxUsers>
        <DurationDays></DurationDays>
        <FixedDate></FixedDate>
    </Listing>
</Listings>

Get a list of users added to a Collection Listing

Get the list of users that have been added to a collection listing entitlement.

Request URI

GET /collectionlistings/{listingid}/users?source={source}

Response Body

<ListingUsers>
    <ListingUser>
        <Id></Id>
        <FirstName></FirstName>
        <LastName></LastName>
        <Username></Username>
        <AccessTill></AccessTill>
        <Active></Active>
    </ListingUser>
    <ListingUser>
        <Id></Id>
        <FirstName></FirstName>
        <LastName></LastName>
        <Username></Username>
        <AccessTill></AccessTill>
        <Active></Active>
    </ListingUser>
</ListingUsers>

Add users to a Collection Listing

Add a list of user records to a collection listing entitlement.

Request URI

POST /collectionlistings/{listingid}/users?source={source}

Request Body

<Users> 
    <User> 
        <Id></Id> 
        <UserName></UserName> 
        <FirstName></FirstName> 
        <LastName></LastName> 
        <Active></Active> 
        <Email></Email> 
        <AccessLevel></AccessLevel> 
        <Brand></Brand> 
    </User> 
    <User> 
        <Id></Id> 
        <UserName></UserName> 
        <FirstName></FirstName> 
        <LastName></LastName> 
        <Active></Active> 
        <Email></Email> 
        <AccessLevel></AccessLevel> 
        <Brand></Brand> 
    </User>
</Users>

Response Body

200 Success

Remove a user from a Collection Listing

Remove a single user record from a collection listing entitlement.

Request URI

DELETE /collectionlistings/{listingid}/users/{userid}?source={source}

Response Header

 200 OK

Get a list of teams added to a Collection Listing

Get a list of team records that have been added to a collection listing entitlement.

Request URI

GET /collectionlistings/{listingid}/teams?source={source}

Response Body

<Teams>
    <Team>
        <Id></Id>
        <Name></Name>
        <TeamCodeForBulkImport></TeamCodeForBulkImport>
        <ParentTeamId i:nil="true"/>
    </Team>
    <Team>
        <Id></Id>
        <Name></Name>
        <TeamCodeForBulkImport></TeamCodeForBulkImport>
        <ParentTeamId i:nil="true"/>
    </Team>
</Teams>

Add a Team to a Collection Listing

Add a Team to a specific Collection Listing.

Request URI

POST /collectionlistings/{listingid}/team/{teamid}?source={source}

Response Header

200 OK

Remove a Team from a Collection Listing

Remove a team from a specific Collection Listing.

Request URI

DELETE /collectionlistings/{listingid}/team/{teamid}?source={source}

Response Header

200 OK

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. Users Via API
  2. Collections Feature Bundle Assets Courses And Learning Paths As Collections
  3. Instructor Led Training Via API

Also of Interest

  • Training Software
  • Employee Training Software
  • Online Learning Companies
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms