Read.LearningObjectives

This method will provide possibility to read Learning Objective data from learning objective repository.

Standard organisation level security was implemented for this method.

Notes:

  • If no Folder ID is specified by the 3rd party the "default node" for the API to return results is the same as the Organisation's Administrator would see through the itslearning UI. So in the case of a school in Forsyth, the 3rd party default node is the "US".

  • Unlike the UI, the API cannot read Learning Objective from all countries even if they know the element ID of the root. Access is limited to single country to which the organization belongs.

  • Only "published" Learning Objectives can be read through the API. This means that subjects (and their children) that are not published will not be returned.

Input parameters

Name

Description

Type

Mandatory/Optional

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

FolderId

Id of the LOR folder to read from

Text

O


Example request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:its="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.LearningObjectives">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ReadLearningObjectives>
         <tem:request>
            <its:FolderId>some_folder</its:FolderId>
         </tem:request>
      </tem:ReadLearningObjectives>
   </soapenv:Body>
</soapenv:Envelope> 

Output parameters

Name

Description

Type

ElementId

Element identifier.

String

Title

Element title.

String

Type

Enum(Folder, Subject, Category, LearningObjective).

Enum

Created

UTC date when this element was created.

Date

UpdatedDate

UTC date when this value was last updated.

Date

Description

Element description.

String

ContainsSubElements

Flag if there are sub elements.

Bool


Example response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2013-07-15T08:04:00.766Z</u:Created>
            <u:Expires>2013-07-15T08:09:00.766Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <ReadLearningObjectivesResponse xmlns="http://tempuri.org/">
         <ReadLearningObjectivesResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.LearningObjectives" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:LearningObjectiveElements>
               <a:LearningObjectiveElement>
                  <a:ElementId>folder1</a:ElementId>
                  <a:Title>folder1</a:Title>
                  <a:Type>Folder</a:Type>
                  <a:Created>2013-07-15T00:00:00</a:Created>
                  <a:UpdatedDate>2013-07-15T00:00:00</a:UpdatedDate>
                  <a:Description>folder1</a:Description>
                  <a:ContainsSubElements>true</a:ContainsSubElements>
               </a:LearningObjectiveElement>
               <a:LearningObjectiveElement>
                  <a:ElementId>subject1</a:ElementId>
                  <a:Title>subject1</a:Title>
                  <a:Type>Subject</a:Type>
                  <a:Created>2013-07-15T00:00:00</a:Created>
                  <a:UpdatedDate>2013-07-15T00:00:00</a:UpdatedDate>
                  <a:Description>subject1</a:Description>
                  <a:ContainsSubElements>true</a:ContainsSubElements>
               </a:LearningObjectiveElement>
            </a:LearningObjectiveElements>
         </ReadLearningObjectivesResult>
      </ReadLearningObjectivesResponse>
   </s:Body>
</s:Envelope>

Error states

  1. The requested Element id does not exist.