(350).png){kind=logo}
API: listCertifications
- 1 Minute to read
- Print
- DarkLight
API: listCertifications
- 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 listCertifications method retrieves certifications that meet the specified filters.
Who Has Access
The following users have access to the listCertifications 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>listCertifications</Method>
<Parameters>
<Certification>
<Page></Page>
<Filters>
<CertificationStatus></CertificationStatus>
</Filters>
</Certification>
</Parameters>
</SmarterU>Certification Tag Group
The Certification tag group is a container for how the response is returned and the certification filters.
<Certification>
<Page></Page>
<Filters>
<CertificationStatus></CertificationStatus>
</Filters>
</Certification>The Certification tag may contain the following.
Page (optional)
The page number to return. The default is 1.
Filters (optional)
The Filters tag is a container for certification filters. Refer to Filters Tag Group.
Filters Tag Group
The Filters tag group is a container for certification filters.
<Filters>
<CertificationStatus></CertificationStatus>
</Filters>The Filters tag may contain the following.
CertificationStatus
The certification'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>
<Certification>
<Certification>
<Name><![CDATA[]]></Name>
<Status></Status>
</Certification>
</Certification>
</Info>
<Errors>
<Error>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Error>
</Errors>
</SmarterU>The Certification tag is a container for the certifications returned by the listCertifications method. Each certification is contained in a Certification tag and may contain the following.
Name
The certification's name.
Status
Example API Response XML Package
Below is an example of an API response XML package.
<SmarterU>
<Result>Success</Result>
<Info>
<Certification>
<Certification>
<Name><![CDATA[Call Center Customer Service]]></Name>
<Status>Active</Status>
</Certification>
<Certification>
<Name><![CDATA[Forklift Operation]]></Name>
<Status>Active</Status>
</Certification>
<Certification>
<Name><![CDATA[Retail Store Management]]></Name>
<Status>Active</Status>
</Certification>
</Certification>
</Info>
<Errors>
</Errors>
</SmarterU>Error Codes
| Error Code | Message |
|---|---|
| LC:01 | The page provided is invalid. |
| LC:02 | The filters provided is invalid. |
| LC:03 | The certification status provided is invalid. |
| LC:04 | The required permissions are not met to call the listCertifications method. |
| LC:05 | The value for a certification status must be Active, Inactive, or All. |
Was this article helpful?