(350).png){kind=logo}
API: getCertification
- 3 Minutes to read
- Print
- DarkLight
API: getCertification
- 3 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 getCertification method retrieves a certification's details.
Who Has Access
The following users have access to the getCertification 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>getCertification</Method>
<Parameters>
<Certification>
<Name><![CDATA[]]></Name>
- OR -
<ID><![CDATA[]]></ID>
</Certification>
</Parameters>
</SmarterU>Certification Tag Group
The Certification tag group is a container for the certification filters.
<Certification>
<Name><![CDATA[]]></Name>
- OR -
<ID><![CDATA[]]></ID>
</Certification>The Certification tag contains one of the following.
Name
The name of the certification to get. This tag is mutually exclusive with the ID tag.
ID
The certification's system-generated identifier. This tag is mutually exclusive with the Name tag.
This is not yet an ID that you can access through the SmarterU system. Please contact our Success Desk to request your IDs.
API Response XML Package
The API response XML package will always include a Result, Info, and Errors tag.
<SmarterU>
<Result></Result>
<Info>
<Certification>
<Name><![CDATA[]]></Name>
<CertificationID><![CDATA[]]></CertificationID>
<CreatedDate></CreatedDate>
<ModifiedDate></ModifiedDate>
<Description><![CDATA[]]></Description>
<CertificationCompletionNotification><![CDATA[]]></CertificationCompletionNotification>
<Roles>
<Role>
<ID></ID>
<Name></Name>
</Role>
</Roles>
<Requirements>
<Requirement>
<ID></ID>
<Name><![CDATA[]]></Name>
<MandateLevel></MandateLevel>
<CompletionOverrideCount></CompletionOverrideCount>
<OverrideEnabled></OverrideEnabled>
<OverrideOption></OverrideOption>
<StickyUntilDate></StickyUntilDate>
<StickyWarningDate></StickyWarningDate>
<SortOrder></SortOrder>
</Requirement>
</Requirements>
<Status></Status>
</Certification>
</Info>
<Errors>
<Error>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Error>
</Errors>
</SmarterU>The certification is contained in a Certification tag and may contain the following.
Name
The certification's name.
CertificationID
The certification's system-generated identifier.
CreatedDate
The date that the certification was added.
ModifiedDate
The date that the certification was last edited.
Description
The certification's description.
CertificationCompletionNotification
Indicates whether an email will be sent to a learner when they complete the certification. Acceptable values are:
- 0 - The email notification is disabled.
- 1 - The email notification is enabled.
Indicates whether the certification's Send Certification Completion Notification setting is enabled (i.e., 0 = disabled; 1 = enabled).
Roles
The Roles tag is a container for the learning plans that include the certification. Each learning plan is contained in a Role tag and contains the following.
| Tag | Description |
|---|---|
ID | The learning plan's system-generated identifier. |
Name | The learning plan's name. |
Requirements
The Requirements tag is a container for the certification's requirements. Each requirement is contained in a Requirement tag and contains the following.
| Tag | Description |
|---|---|
ID | The requirement's system-generated identifier. |
Name | The requirement's name. |
MandateLevel | The requirement's mandate level. Acceptable values are:
|
CompletionOverrideCount | The minimum number of requirement blocks a learner must complete. |
OverrideEnabled | Indicates whether the requirement's expiration status is overridden. Acceptable values are:
|
OverrideOption | Indicates the requirement's expiration override option. Acceptable values are:
|
StickyUntilDate | |
StickyWarningDate | The date that the requirement status will change to Warning. |
SortOrder | The position of this requirement in relation to other requirements assigned to the certification. |
Status
Example API Response XML Package
Below is an example of an API response XML package.
<SmarterU>
<Result>Success</Result>
<Info>
<Certification>
<Name><![CDATA[Forklift Operation]]></Name>
<CertificationID><![CDATA[10222]]></CertificationID>
<CreatedDate>2018-03-21 21:35:56.22</CreatedDate>
<ModifiedDate>2018-05-29 17:17:29.787</ModifiedDate>
<Description><![CDATA[Forklift operator certification]]></Description>
<CertificationCompletionNotification><![CDATA[1]]></CertificationCompletionNotification>
<Roles>
<Role>
<ID/>
<Name>Forklift Operator</Name>
</Role>
<Role>
<ID/>
<Name>Manufacturing Floor Manager</Name>
</Role>
</Roles>
<Requirements>
<Requirement>
<ID>14672</ID>
<Name><![CDATA[Forklift Operator]]></Name>
<MandateLevel>Mandatory</MandateLevel>
<CompletionOverrideCount/>
<OverrideEnabled>0</OverrideEnabled>
<OverrideOption>None</OverrideOption>
<StickyUntilDate/>
<StickyWarningDate/>
<SortOrder>1</SortOrder>
</Requirement>
</Requirements>
<Status>Active</Status>
</Certification>
</Info>
<Errors>
</Errors>
</SmarterU>Error Codes
| Error Code | Message |
|---|---|
| GC:01 | The name provided is invalid. |
| GC:02 | The ID provided is invalid. |
| GC:03 | The required permissions are not met to call the getCertification method. |
| GC:04 | The requested Certification does not exist. |
| GC:05 | Certification name and ID not provided. You must provide a Name or ID. |
Was this article helpful?