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=MyApp
Request Body
<Collection>
<Name></Name>
<Description></Description>
<DefaultListing>true/false</DefaultListing>
<ImageURL></ImageUR>
</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>
Create a Collection Listing
Creates a new Listing within a given Collection.
Request Uri
POST /collectionlistings?&source=MyApp
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>
Get a list of Collections
Returns a list of Collections that have been created in the org.
Request Uri
GET /collections?source=MyApp
Response Body
<Collections>
<Collection>
<Id></Id>
<Name></Name>
</Collection>
<Collection>
<Id></Id>
<Name></Name>
</Collection>
</Collections>
Get a list of Collection Listings
Returns a list of Collection Listings that have been created for a specific Collection in the org.
Request Uri
GET /collectionlistings/{collectionid}?source=MyApp
Response Body
<Listings>
<Listing>
<Id></Id>
<Name></Name>
<Active></Active>
<DurationType></DurationType>
<MaxUsers></<MaxUsers>
<DurationDays></DurationDay>
<FixedDate></FixedDate>
</Listing>
<Listing>
<Listing>
<Id></Id>
<Name></Name>
<Active></Active>
<DurationType></DurationType>
<MaxUsers></<MaxUsers>
<DurationDays></DurationDay>
<FixedDate></FixedDate>
</Listing>
</Listings>
Get a list of users added to a Collection Listing
Returns a list of users that have been added to a specific Collection Listing.
Request Uri
GET /collectionlistings/{listingid}/users?&source=MyApp
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
Specify a list of users that need to be added to a specific Collection Listing.
Request Uri
POST /collectionlistings/{listingid}/users?&source=MyApp&format=json
Request Body
[
{
"Id": "UserId",
"UserName": "Username",
"FirstName": null,
"LastName": null,
"Active": true,
"Email": null,
"AccessLevel": null,
"Brand": null
},
{
"Id": "UserId",
"UserName": "Username",
"FirstName": null,
"LastName": null,
"Active": true,
"Email": null,
"AccessLevel": null,
"Brand": null
}
]
Response Body
201 Created
Delete a user from a Collection Listing
Specify a list of users that need to be added to a specific Collection Listing.
Request Uri
DELETE /collectionlistings/{listingid}/users/{userid}?&source=MyApp
Response Header
200 OK
Get a list of teams added to a Collection Listing
Returns a list of users that have been added to a specific Collection Listing.
Request Uri
GET /collectionlistings/{listingid}/teams?&source=MyApp
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=MyApp
Response Header
200 OK
Remove a Team to a Collection Listing
Remove a team from a specific Collection Listing.
Request Uri
DELETE /collectionlistings/{listingid}/team/{teamid}?&source=MyApp
Response Header
200 OK
Comments
0 comments
Article is closed for comments.