API: updateRequirement

Description

The updateRequirement method edits a requirement.

Who Has Access

The following users have access to the updateRequirement method:

• Users with the Manage Learning Plans, Certifications, and Requirements or View Learning Plans, Certifications, and Requirements account permission.

• Administrators and owners.

API Call XML Package

SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>updateRequirement</Method>
   <Parameters>
      <Requirement>
         <Identifier>
            <Name></Name>
               - OR - 
            <ID></ID>
         </Identifier>
         <Name></Name>
         <Status></Status>
         <Description></Description>
         <ReqExpires></ReqExpires>
         <DaysGood></DaysGood>
         <ExpirationDate></ExpirationDate>
         <RecallDays></RecallDays>
         <MetByDefault></MetByDefault>
         <DaysMet></DaysMet>
         <DaysMetWarning></DaysMetWarning>

         <Blocks>
            <Block>
               <BlockID></BlockID>
               <BlockSortOrder></BlockSortOrder>
               <BlockAction></BlockAction>
               <Items>
                  <Item>
                     <ItemAction></ItemAction>
                     <LearningModuleID></LearningModuleID>
                     <CredentialName></CredentialName>
                     <Type></Type>
                     <SelfEnroll></SelfEnroll>
                     <AutoEnroll></AutoEnroll>
                     <AutoEnrollIlt></AutoEnrollIlt>
                     <AutoEnrollOnFailure></AutoEnrollOnFailure>
                     <SortOrder></SortOrder>
                  </Item>
               </Items>
            </Block>
         </Blocks>
     </Requirement>
   </Parameters>
</SmarterU>

Requirement Tag Group

The Requirement tag group is a container for the requirement's details. 

<Requirement>
   <Identifier>
      <Name></Name>
         - OR - 
      <ID></ID>
   </Identifier>
   <Name></Name>
   <Status></Status>
   <Description></Description>
   <ReqExpires></ReqExpires>
   <DaysGood></DaysGood>
   <ExpirationDate></ExpirationDate>
   <RecallDays></RecallDays>
   <MetByDefault></MetByDefault>
   <DaysMet></DaysMet>
   <DaysMetWarning></DaysMetWarning>

   <Blocks>
      <Block>
         <BlockID></BlockID>
         <BlockSortOrder></BlockSortOrder>
         <BlockAction></BlockAction>
         <Items>
            <Item>
               <ItemAction></ItemAction>
               <LearningModuleID></LearningModuleID>
               <CredentialName></CredentialName>
               <Type></Type>
               <SelfEnroll></SelfEnroll>
               <AutoEnroll></AutoEnroll>
               <AutoEnrollIlt></AutoEnrollIlt>
               <AutoEnrollOnFailure></AutoEnrollOnFailure>
               <SortOrder></SortOrder>
            </Item>
         </Items>
      </Block>
   </Blocks>
</Requirement>

The Requirement tag may contain the following. 

Identifier

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

Name

The requirement's name.

Status

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

Description

The requirement's description.

ReqExpires (optional)

DaysGood (optional)

This is only used when ReqExpires tag is set to 1. 

ExpirationDate (optional)

This tag is only used when the ReqExpires tag is set to 1 and you want the requirement to expire on a specific date. 

RecallDays (optional)

This is only used when ReqExpires tag is set to 1. 

MetByDefault (optional)

DaysMet (optional)

This tag is only used when MetByDefault is set to 1. 

DaysMetWarning (optional)

This setting is only used when MetByDefault is set to 1. 

Blocks (optional)

A container for the requirement's blocks. Refer to Blocks Tag Group.

Blocks Tag Group

The Blocks tag group is a container for the requirement's blocks.

<Blocks>
   <Block>
      <BlockSortOrder></BlockSortOrder>
      <BlockAction></BlockAction>
      <Items>
         <Item>
            <ItemAction></ItemAction>
            <LearningModuleID></LearningModuleID>
            <ItemName></ItemName>
            <Type></Type>
            <SelfEnroll></SelfEnroll>
            <AutoEnroll></AutoEnroll>
            <AutoEnrollIlt></AutoEnrollIlt>
            <AutoEnrollOnFailure></AutoEnrollOnFailure>
            <SortOrder></SortOrder>
         </Item>
      </Items>
   </Block>
</Blocks>

Each block is contained in a Block tag and contains the following.

BlockSortOrder (optional)

The order that the block will be displayed.

BlockAction

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

• Add - You're adding the block to the requirement.

• Remove - You're removing the block from the requirement.

Items

A container for the requirement block's courses and actions. Each course or action is contained in an Item tag and may contain the following. 

API Response XML Package

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

<SmarterU>
   <Result></Result>
   <Info>
      <Requirement><![CDATA[]]></Requirement>
      <RequirementID><![CDATA[]]></RequirementID>
   </Info>

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

The response may also contain the following. 

Requirement

The requirement's name.

RequirementID

The requirement's system-generated identifier.

Example API Response XML Package

Below is an example of an API response XML package.

<SmarterU>
   <Result>Success</Result>
   <Info>
      <Requirement><![CDATA[Conflict Resolution]]></Requirement>
      <RequirementID><![CDATA[26055]]></RequirementID>
   </Info>

   <Errors>
   </Errors>
</SmarterU>

Error Codes