(350).png){kind=logo}
API: listRequirements
- 1 Minute to read
- Print
- DarkLight
API: listRequirements
- 1 Minute 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 listRequirements method retrieves requirements that meet the specified filters.
Who Has Access
The following users have access to the listRequirements method:
- Users with the Manage Learning Plans, Certifications, and Requirements account permission.
- Administrators and owners.
API Call XML Package
<SmarterU>
<AccountAPI><![CDATA[]]></AccountAPI>
<UserAPI><![CDATA[]]></UserAPI>
<Method>listRequirements</Method>
<Parameters>
<Requirement>
<Page></Page>
<Filters>
<RequirementStatus></RequirementStatus>
</Filters>
</Requirement>
</Parameters>
</SmarterU>Requirement Tag Group
The Requirement tag group is a container for how the response is returned and the requirement filters.
<Requirement>
<Page></Page>
<Filters>
<RequirementStatus></RequirementStatus>
</Filters>
</Requirement>The Requirement tag may contain the following tags:
Page (optional)
The page number to return. The default is 1. Up to 50 results are returned by default.
Filters (optional)
A container for the requirement status filter. This tag contains the following.
| Tag | Description |
|---|---|
| RequirementStatus | The requirement's status. Acceptable values are Active, Inactive, or All. The default is All. |
API Response XML Package
The API response XML package will always include a Result, Info, and Errors tag.
<SmarterU>
<Result></Result>
<Info>
<Requirement>
<Requirement>
<Name><![CDATA[]]></Name>
<Status></Status>
</Requirement>
</Requirement>
</Info>
<Errors>
<Error>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Error>
</Errors>
</SmarterU>The Requirement tag is a container for the requirements returned by the listRequirements method. Each requirement is contained in a Requirement tag and may contain the following.
Name
The requirement's name.
Status
The requirement's status.
Example API Response XML Package
Below is an example of an API response XML package.
<SmarterU>
<Result>Success</Result>
<Info>
<Requirement>
<Requirement>
<Name><![CDATA[Call Center Customer Service]]></Name>
<Status>Active</Status>
</Requirement>
<Requirement>
<Name><![CDATA[Forklift Operator]]></Name>
<Status>Active</Status>
</Requirement>
<Requirement>
<Name><![CDATA[Retail Merchandising]]></Name>
<Status>Active</Status>
</Requirement>
</Requirement>
</Info>
<Errors>
</Errors>
</SmarterU>Error Codes
| Error Code | Message |
|---|---|
| LR:01 | The page provided is invalid. |
| LR:02 | The filters provided is invalid. |
| LR:03 | The requirement status provided is invalid. |
| LR:04 | The required permissions are not met to call the listRequirements method. |
| LR:05 | The value for a requirement status must be Active, Inactive, or All. |
Was this article helpful?