(350).png){kind=logo}
API: listSubscriptionLearningModules
- 2 Minutes to read
- Print
- DarkLight
API: listSubscriptionLearningModules
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
- Starting June 1, 2022, SmarterU will require all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
- If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
- Tags are required unless specified.
Description
The listSubscriptionLearningModules method retrieves courses associated with a subscription.
Who Has Access
Administrators and owners have access to the listSubscriptionLearningModules method.
API Call XML Package
<SmarterU>
<AccountAPI><![CDATA[]]></AccountAPI>
<UserAPI><![CDATA[]]></UserAPI>
<Method>listSubscriptionLearningModules</Method>
<Parameters>
<Subscription>
<SubscriptionID><![CDATA[]]></SubscriptionID>
</Subscription>
</Parameters>
</SmarterU>Subscription Tag Group
The Subscription tag group is a container for the subscription.
<Subscription>
<SubscriptionID><![CDATA[]]></SubscriptionID>
</Subscription>The Subscription tag contains the following.
SubscriptionID
The subscription's system-generated identifier. This is the SubscriptionID returned by the listSubscriptions method.
API Response XML Package
The API response XML package will always include a Result, Info, and Errors tag.
<SmarterU>
<Result>Success</Result>
<Info>
<LearningModules>
<LearningModule>
<LearningModuleID><![CDATA[]]></LearningModuleID>
<Name><![CDATA[]]></Name>
<Identifier><![CDATA[]]><Identifier/>
<Status><![CDATA[]]></Status>
<Description><![CDATA[]]></Description>
<DescriptionHTML><![CDATA[]]></DescriptionHTML>
</LearningModule>
</LearningModules>
</Info>
<Errors>
<Error>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Error>
</Errors>
</SmarterU>The LearningModules tag is a container for the courses returned by the listSubscriptionLearningModules method. Each course is contained in a LearningModule tag and may contain the following.
LearningModuleID
The course's system-generated identifier. This is the LearningModuleID returned by the listLearningModules method.
Name
The course's name.
Identifier
The course's user-specified identifier.
Status
The course status (i.e., Active, Inactive, or Archived).
Description
The course's description.
DescriptionHTML
The course's description in HTML code.
This only returns the HTML and does not contain any internal SmarterU styles.
If your description contains an image, the code for the image will only include the relative link. The code will not include the "app.smarteru.com" prefix that is included when the image is displayed from within SmarterU. Images may not display correctly if you attempt to use the code returned by the DescriptionHTML tag.
Example API Response XML Package
Below is an example of an API response XML package.
<SmarterU>
<Result>Success</Result>
<Info>
<LearningModules>
<LearningModule>
<LearningModuleID>1973</LearningModuleID>
<Name><![CDATA[Customer Service at Fina Shoes]]></Name>
<Identifier/>
<Status><![CDATA[Active]]></Status>
<Description><![CDATA[In this module you will learn about Fina Shoes' award-winning customer service policies and practices. You will learn how to increase customer satisfaction, perform a transaction, and process returns and exchanges.]]></Description>
<DescriptionHTML><![CDATA[<p>In this module you will learn about Fina Shoes' award-winning customer service policies and practices. You will learn how to increase customer satisfaction, perform a transaction, and process returns and exchanges.</p>]]></DescriptionHTML>
</LearningModule>
<LearningModule>
<LearningModuleID>63873</LearningModuleID>
<Name><![CDATA[History of Fina]]></Name>
<Identifier/>
<Status><![CDATA[Active]]></Status>
<Description><![CDATA[Learn about Fina's history.]]></Description>
<DescriptionHTML><![CDATA[<p>Learn about Fina's history.</p>]]></DescriptionHTML>
</LearningModule>
</LearningModules>
</Info>
<Errors>
</Errors>
</SmarterU>Error Codes
| Error Code | Message |
|---|---|
| LSLM02 | The required permissions are not met to call the listSubscriptionLearningModules method. |
Was this article helpful?