API: createCertification
  • 4 Minutes to read
  • Dark
    Light

API: createCertification

  • Dark
    Light

  • 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 createCertification method adds a certification.

Who Has Access

The following users have access to the createCertification method:

API Call XML Package

<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>createCertification</Method>
   <Parameters>
      <Certification>
         <Name><![CDATA[]]></Name>
         <Status><![CDATA[]]></Status>
         <Description><![CDATA[]]></Description>
         <LearnerCompletion><![CDATA[]]></LearnerCompletion>
         <Requirements>
            <Requirement>
               <RequirementName><![CDATA[]]></RequirementName>
               <MandateLevel><![CDATA[]]></MandateLevel>
               <CompletionOverrideCount><![CDATA[]]></CompletionOverrideCount>
               <OverrideEnabled><![CDATA[]]></OverrideEnabled>
               <OverrideOption><![CDATA[]]></OverrideOption>
               <StickyUntilDate><![CDATA[]]></StickyUntilDate>
               <StickyWarningDate><![CDATA[]]></StickyWarningDate>
               <SortOrder><![CDATA[]]></SortOrder>
            </Requirement>
          </Requirements>
      </Certification>
   </Parameters>
</SmarterU>

Certification Tag Group

The Certification tag group is a container for the certification's details. 

<Certification>
   <Name><![CDATA[]]></Name>
   <Status><![CDATA[]]></Status>
   <Description><![CDATA[]]></Description>
   <LearnerCompletion><![CDATA[]]></LearnerCompletion>
   <Requirements>
      <Requirement>
         <RequirementName><![CDATA[]]></RequirementName>
         <MandateLevel><![CDATA[]]></MandateLevel>
         <CompletionOverrideCount><![CDATA[]]></CompletionOverrideCount>
         <OverrideEnabled><![CDATA[]]></OverrideEnabled>
         <OverrideOption><![CDATA[]]></OverrideOption>
         <StickyUntilDate><![CDATA[]]></StickyUntilDate>
         <StickyWarningDate><![CDATA[]]></StickyWarningDate>
         <SortOrder><![CDATA[]]></SortOrder>
      </Requirement>
   </Requirements>
</Certification>

The Certification tag may contain the following.

Name

The certification's name

Status

The certification's status. Acceptable values are Active or Inactive

Description

The description of the certification.

LearnerCompletion (optional)

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.

Requirements

A container for the certification's requirements. Refer to Requirements Tag Group.

Requirements Tag Group

The Requirements tag group is a container for the certification's requirements.

<Requirements>
   <Requirement>
      <RequirementName><![CDATA[]]></RequirementName>
      <MandateLevel><![CDATA[]]></MandateLevel>
      <CompletionOverrideCount><![CDATA[]]></CompletionOverrideCount>
      <OverrideEnabled><![CDATA[]]></OverrideEnabled>
      <OverrideOption><![CDATA[]]></OverrideOption>
      <StickyUntilDate><![CDATA[]]></StickyUntilDate>
      <StickyWarningDate><![CDATA[]]></StickyWarningDate>
      <SortOrder><![CDATA[]]></SortOrder>
   </Requirement>
</Requirements>

Each requirement is contained in a Requirement tag and may contain the following.

RequirementName

The requirement's name. Requirements cannot be added more than once.

MandateLevel

The requirement's mandate level. Acceptable values are:

  • Mandatory - The requirement is required for the certification.
  • Recommended - The requirement is not required, but recommended for the certification. If you select this option, you can specify the minimum number of courses, credentials, or tasks that need to be completed for the requirement. This is particularly helpful for managing electives as part of the certification process.
  • Optional - The requirement is optional for the certification. If you select this option, you can specify the minimum number of courses, credentials, or tasks that need to be completed for the requirement. This is particularly helpful for managing electives as part of the certification process.

CompletionOverrideCount (optional)

The minimum number of requirement blocks a learner must complete.

OverrideEnabled (optional)

Indicates whether the requirement's expiration status is overridden. Acceptable values are:

  • 0 - The expiration status is not overridden.
  • 1 - The expiration status is overriden.

OverrideOption (optional)

Indicates the requirement's expiration override option. Acceptable values are:

  • Permanent - The requirement's expiration status is overridden indefinitely. 
  • Sticky - The requirement's expiration status is overridden for the specified period of time. You can use this option to either extend the length of time users' certifications have a Met status, or force a status change on a requirement that doesn't expire.

StickyUntilDate (optional)

The date in dd-mmm-yyyy format that the requirement will expire.

StickyWarningDate (optional)

The date in dd-mmm-yyyy format that the user's requirement status will change to Warning.

SortOrder (optional)

The position of this requirement in relation to other requirements assigned to the same certification. 1 indicates that the requirement is first.

API Response XML Package

The API response XML package will always include a Result, Info, and Errors tag.

<SmarterU>
   <Result></Result>
   <Info>
      <Certification><![CDATA[]]></Certification>
      <CertificationID></CertificationID>
   </Info>

   <Errors>
      <Error>
         <ErrorID></ErrorID>
         <ErrorMessage></ErrorMessage>
      </Error>
   </Errors>
</SmarterU>

The response may also contain the following. 

Certification

The certification's name.

CertificationID

The certification's system-generated identifier.

Example API Response XML Package

Below is an example of an API response XML package.

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Certification><![CDATA[Fina Footwear Specialist]]></Certification>
      <CertificationID/>
   </Info>

   <Errors>
   </Errors>
</SmarterU>

Error Codes

Error CodeMessage
CC:01The name provided is invalid.
CC:02The learner completion provided is invalid.
CC:03The status provided is invalid.
CC:04The description provided is invalid.
CC:05The requirement provided is invalid.
CC:06The requirement name provided is invalid.
CC:07The mandate level provided is invalid.
CC:08The requirement action provided is invalid.
CC:09The completion override count provided is invalid.
CC:10The override enabled provided is invalid.
CC:11The override option provided is invalid.
CC:12The sticky until date provided is invalid.
CC:13The sticky warning date provided is invalid.
CC:14The sort order provided is invalid.
CC:15The required permissions are not met to call the createCertification method.
CC:16The status provided is not valid. Only Active or Inactive are allowed values.
CC:17One or more of the requirements provided are not valid. Requirements cannot be added more than once.
CC:18One or more of the requirement names provided are not valid.
CC:19One or more mandate levels provided are not valid. Only Mandatory, Optional,  or Recommended are allowed values actions in this requirement.
CC:20One or more override option provided are not valid. Only None, Permanent, or Sticky are allowed values
CC:21Certification name cannot be used.
CC:22The required permissions are not met to call the createCertification method.
CC:23Sticky until date provided is not valid. The allowed format is dd-mmm-YYYY.
CC:24Sticky warning date provided is not valid. The allowed format is dd-mmm-YYYY.
CC:25Sticky until date should be greater than sticky warning date.
CC:26Sticky warning date and sticky until date are required when override option is Sticky.
CC:27Override option should be Sticky or Permanent when override enabled is 1.
CC:28Completion override count should be less than or equal to the number of courses and actions in this requirement.
CC:29Sticky warning date and sticky until date should not be provided when override option is not Sticky.

Was this article helpful?