Contents x
    API: updateCertification
    • 4 Minutes to read
    • Print
    • Dark
      Light
    Contents

    API: updateCertification

    • 4 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    • 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 updateCertification method edits a certification.

    Who Has Access

    The following users have access to the updateCertification method:

    API Call XML Package

    <SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>updateCertification</Method>
   <Parameters>    
      <Certification>
         <Identifier>
            <Name><![CDATA[]]></Name>
               - OR -
            <ID><![CDATA[]]></ID>
         </Identifier>
         <Name><![CDATA[]]></Name>
         <Status><![CDATA[]]></Status>
         <Description><![CDATA[]]></Description>
         <LearnerCompletion><![CDATA[]]></LearnerCompletion>
         <Requirements>
            <Requirement>
               <RequirementName><![CDATA[]]></RequirementName>
               <MandateLevel><![CDATA[]]></MandateLevel>
               <RequirementAction><![CDATA[]]></RequirementAction>
               <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>
   <Identifier>
      <Name><![CDATA[]]></Name>
         - OR -
      <ID><![CDATA[]]></ID>
   </Identifier>
   <Name><![CDATA[]]></Name>
   <Status><![CDATA[]]></Status>
   <Description><![CDATA[]]></Description>
   <LearnerCompletion><![CDATA[]]></LearnerCompletion>
   <Requirements>
      <Requirement>
         <RequirementName><![CDATA[]]></RequirementName>
         <MandateLevel><![CDATA[]]></MandateLevel>
         <RequirementAction><![CDATA[]]></RequirementAction>
         <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. 

    The Identifier tag contains the information for the certification you want to update. The remaining tags in the Certification tag group specify the updates to the certification. 

    Identifier

    The identifier of the certification you want to update. This tag contains the following.

    Tag Description

    Name

    The certification's name. 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 the CertificationID returned by the getCertification method. 

    Name (optional)

    The certification's name. 

    Status (optional)

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

    Description (optional)

    The description for 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 (optional)

    A container for assigning requirements to or removing requirements from the certification. Refer to Requirements Tag Group.

    Requirements Tag Group

    The Requirements tag group is a container for assigning requirements to or removing requirements from the certification. 

    <Requirements>
   <Requirement>
      <RequirementName><![CDATA[]]></RequirementName>
      <MandateLevel><![CDATA[]]></MandateLevel>
      <RequirementAction><![CDATA[]]></RequirementAction>
      <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.

    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

    The minimum number of requirement blocks a learner must complete.

    RequirementAction

    Indicates the action you are taking on the certification's requirement. Acceptable values are:

    • Add - You're adding the requirement to the certification, or updating a requirement that was previously added to the certification.
    • Remove - You're removing the requirement from the certification.

    OverrideEnabled

    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

    This tag is only required when OverrideEnabled is set to 1.

    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.

    StickyUntilDate

    This tag is only required when OverrideOption is set to Sticky. The date in dd-mmm-yyyy format that the requirement will expire.

    StickyWarningDate

    This tag is only required when OverrideOption is set to Sticky. The date in dd-mmm-yyyy format that the user's requirement status will change to Warning.

    SortOrder

    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><![CDATA[]]></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><![CDATA[17963]]></CertificationID>
    </Info>
    <Errors>
    </Errors>
</SmarterU>

    Error Codes

    Error CodeMessage
    UC:01
    		The identifier provided is invalid.
    UC:02
    		The name provided is invalid.
    UC:03
    		The ID provided is invalid.
    UC:04
    		The learner completion provided is invalid.
    UC:05
    		The status provided is invalid.
    UC:06
    		The description provided is invalid.
    UC:07
    		The requirement provided is invalid.
    UC:08
    		The requirement name provided is invalid.
    UC:09
    		The mandate level provided is invalid.
    UC:10
    		The requirement action provided is invalid.
    UC:11
    		The completion override count provided is invalid.
    UC:12
    		The override enabled provided is invalid.
    UC:13
    		The override option provided is invalid.
    UC:14
    		The sticky until date provided is invalid.
    UC:15
    		The sticky warning date provided is invalid.
    UC:16
    		The sort order provided is invalid.
    UC:17
    		The required permissions are not met to call the updateCertification method.
    UC:18
    		The requested certification does not exist.
    UC:19
    		The status provided is not valid. Only Active or Inactive are allowed values.
    UC:20
    		Completion override count should be less than or equal to the number of courses and actions in this requirement.
    UC:21
    		One or more of the requirement names provided are not valid.
    UC:22
    		One or more mandate levels provided are not valid. Only Mandatory, Optional, or Recommended are allowed values.
    UC:23
    		One or more mandate levels provided are not valid. Only Mandatory, Optional, or Recommended are allowed values.
    UC:24
    		Requirement name is required.
    UC:25
    		One or more override options provided are not valid. Only None, Permanent, or Sticky are allowed values.
    UC:26
    		The requirement action provided is not valid. Only Add or Remove are allowed values.
    UC:27
    		Certification name cannot be used.
    UC:28
    		The required permissions are not met to call the updateCertification method.
    UC:29
    		Sticky until date provided is not valid. The allowed format is dd-mmm-YYYY.
    UC:30
    		Sticky warning date provided is not valid. The allowed format is dd-mmm-YYYY.
    UC:31
    		Override option should be Sticky or Permanent when OverrideEnabled is 1.
    UC:32
    		Sticky warning date and sticky until date are required when OverrideOption is Sticky.
    UC:33 
    		Sticky until date should be after sticky warning date.
    UC:34 
    		Requirement provided was not found on this certification.
    Was this article helpful?
    Related articles
    What's Next
    SmarterU LMS is proudly located in the heart of North America, helping our clients around the globe unleash their human potential and increase their organizational intelligence.
    SmarterU LMS
    Company
    Top Features
    Contact Us
    Follow Us
    SmarterU LMS Copyright © 2006-  Neovation Corporation. All rights reserved.
    SmarterU and Success Desk are trademarks of Neovation Corporation.