Read.Course.Element

This method will provide possibility to read certain element data from course.

Standard organisation level security was implemented for this method.

Input parameters

Name

Description

Type

Mandatory/Optional

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

ElementId

Id of the element

Int

Linked to next field - M/O

ElementSyncKey

SyncKey of the element

Text

M/O

CourseId

Id of the course

Int

Linked to next field - M/O

CourseSyncKey

SyncKey of the course

Text

M/O

IncludeContent

If set to true, the result set will contain the element's content. If set to false, the Content output parameter will always be null.

Boolean

Optional (defaults to false)



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" xmlns:its1="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.AssessmentRecordSummary">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadCourseElement>
<its:CourseId>1233445</its:CourseId>
<its:ElementId>23</its:ElementId>
</tem:ReadLearningObjectives>
</soapenv:Body>
</soapenv:Envelope>

Example request - returns element with the element's content


<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" xmlns:its1="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.AssessmentRecordSummary">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadCourseElement>
<its:CourseId>1233445</its:CourseId>
<its:ElementId>23</its:ElementId>
<its:IncludeContent>true</its:IncludeContent>
</tem:ReadCourseElement>
</soapenv:Body>
</soapenv:Envelope>

Output parameters

Name

Description

Type

Element

Represents a single course element (i.e. everything that's not a folder).

Parent element

Element / ElementID

Identifier of the element.

Integer

Element / ElementNo

Order of the element within the course.

Integer

Element / Title

Title of the element.

String

Element / Type

Type of element (e.g. Note, LearningToolElement).

String

Element / ExtensionID

Extensions only - the identifier of the extension.

Integer

Element / Active From

Date from which the element became active.

Date/Time

Element / ActiveTo

Date at which the element will no longer be active.

Date/Time

Element / Content

Element content.

Complex type

Element / LearningObjectives

List of associated learning objective or null

Array

LearningObjective

Learning objective element

Parent element

LearningObjective / LearningObjectiveId

Learning objective identifier from repository

String

LearningObjective / Title

Learning objective title

String

LearningObjective / Description

Learning objective description

String



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-02T13:35:31.208Z</u:Created>
<u:Expires>2013-07-02T13:40:31.208Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
< ReadCourseElementResult>
<a:Element>
<a:ActiveFrom>2012-01-01T23:59:59</a:ActiveFrom>
<a:ActiveTo>2013-12-31T23:59:59</a:ActiveTo>
<a:Content i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.ContentEntities"/>
<a:ElementId>75</a:ElementId>
<a:ElementNo>1</a:ElementNo>
<a:ElementType>CustomActivity</a:ElementType>
<a:ExtensionId i:nil="true"/>
<a:LearningObjectives>
<a:LearningObjective>
<a:LearningObjectiveId>CD124102-76D8-11DC-B172</a:LearningObjectiveId>
<a:Title>B1a</a:Title>
<a:Description>Demonstrates comprehension of the variety of literary forms in the biblical text</a:Description>
</a:LearningObjective>
</a:LearningObjectives>
<a:Title>Some Note</a:Title>
</a:Element>
</ReadCourseElementResult>
</s:Body>
</s:Envelope>

Example response with content

<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-02T13:35:31.208Z</u:Created>
<u:Expires>2013-07-02T13:40:31.208Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
< ReadCourseElementResult>
<a:Element>        
<a:ActiveFrom i:nil="true"/>
<a:ActiveTo i:nil="true"/>
<a:Content i:type="b:ResourceFileContent" xmlns:b="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.ContentEntities">
<b:Description/>
<b:FileContentType>image/jpeg</b:FileContentType>
<b:FileLink>https://localhost:1000/ddb0cd98-e44a-41c7-8319-c9d58253f6be?Token=gBoGAAEAAACHn_thAAAAACAAi_oGmiESjcqRaHOv59gDNZqxKzBCRrruzP8ORUo6SZUAAA&Download=1</b:FileLink>
<b:FileName>Test.jpg</b:FileName>
</a:Content>
<a:ElementId>297</a:ElementId>
<a:ElementNo>188</a:ElementNo>
<a:ElementType>LearningToolElement</a:ElementType>
<a:ExtensionId>5009</a:ExtensionId>
<a:LearningObjectives/>
<a:Title>Test</a:Title>
    </a:Element>
</ReadCourseElementResult>
</s:Body>
</s:Envelope>

Error states

  1. Message must contain valid CourseId/CourseSyncKey.

  2. Only one of either CourseId or CourseSyncKey parameter can be specified.

  3. Course with specified CourseId/CourseSyncKey is not valid.

  4. You do not have access to this course.

  5. Course is deleted.

  6. Message must contain valid ElementId/ElementSyncKey.

  7. Only one of either ElementId or ElementSyncKey parameter can be specified.

  8. Element with specified ElementId/ElementSyncKey is not valid.

  9. Element is deleted.

  10. Element is not within the course specified.