Update.Extension.Instance

Method to manipulate content of existing learning objects.

Action

This type of message will update an extension element.

Input Parameters

Message

Name

Description

Type

M/O

SiteId

Site where action will be executed

Int

O

VendorId

VendorId which will be associated with created content

Text

O

ContentId

Id of the learning object instance.

Integer

O/M

ContentSyncKey

Learning object sync key.

Text

O/M

UserId

Last updated UserId.

Integer

O/M

UserSyncKey

Last updated user SyncKey.

Text

O/M

Title

ExtensionInstance title in itslearning

Text. Must not be blank. Must follow same rules as UI

O

Metadata

Metadata information for in My Library

ComplexType - MetaDataType

O

Sharing

Sharing information

ComplexType - SharingType

O

Content

Page content in XML format corresponding to the extension format.

Specfic extension format can be retrieved with the GetExtensions method.

Possible content:

XML

O

DisallowModification

Defines if the user is allowed to make their own version of the resource. If the value is not specified it considers as false.

Boolean

O

ElementProperties

Element properties

ComplexType - ElementPropertiesType

O

MetadataType

Name

Description

Type

M/O

Description

Text description

Text

O

Language

Language in culture format e.g. en-US

Text

O

Format

Format

Text

  • Any

  • Audio

  • Image

  • Interactive

  • Text

  • Video

O

Keywords

Complex type - an array of KeywordType

O

LearningObjectives

Complex type - an array of LearningObjectivesType

O

IntendedEndUserRole

The intended user of the content. If this is not specified then the content is assumed to be suitable for all user groups. Vocab is based on IMS LOM roles standard. IMSGLC_CC_Rolesv1p1 vocab

Example: < IntendedEndUserRole> Learner Instructor</ IntendedEndUserRole>

Text ( One or more)

  • Learner

  • Instructor

  • Mentor

O

Grade

The grade level (or grade level range) of the materials. In LangString format (values separated with spaces).

Allowed values: K, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13

Text

O

Duration (note: at this moment this is not used)

The Duration provides the length of the period according to [ISO8601, 00], for example P3M for three months, PT3m58s for three minutes 58 seconds. A optional description of the Duration can be provided for periods that are not well described by this scheme, for example "about half an hour". The description is given as a LangString.

Complex type - DurationType

O

ThumbnailUrl

Url of the thumbnail associated with the learning object

Text

O

EducationalIntent

The educational intent of the resource.

Example: <EducationalIntent>Instructional Practice</EducationalIntent>

Text (One or more)

  • Instructional

  • Practice

  • ProfessionalDevelopment

  • Assessment

  • Activity

O

HasFlashContent

Set to true to indicate that the resource has Adobe Flash content

Boolean

O

IntendedAge

The ages that the material is intended for, In LangString format (values separated with spaces).

Allowed values: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18

Text

O

Publisher

The name of the publisher

Text

O

ReadingGradeLevel

The reading grade level (or grade level range) of the materials. Either a single value (X) or a range (X-Y), where X and Y are one of: K, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13

Text

O

KnovationReadabilityScore

The reading grade level (or grade level range) of the materials. Either a single value (X) or a range (X-Y), where X and Y are one of: 1, 2, 3, 4, 5

NOTE: This can only be set by the content vendor "Knovation"

Text

O

LexileScore

The reading grade level (or grade level range) of the materials. Either a single value (X) or a range (X-Y), where X and Y are valid lexile scores (for example 250L or 1440L)

Text

O

KeywordType

Name

Description

Type

M/O

Keyword

The keyword

Text

O

LearningObjectivesType

Name

Description

Type

M/O

LearningObjective

Complex type - an array of LearningObjectiveType

O

LearningObjectiveType

Name

Description

Type

M/O

LearningObjectiveId

The learning objective ID

Text

O

SharingType

Name

Description

Type

M/O

Scope

Scope

Text

  • Private

  • School

  • Site

  • Community

  • Custom

O

OrganisationSyncKey

SyncKey of the organisation

Text

O

Sites

Array of sites when sharing scope is custom

Complex type - SitesType

O

Notes:OrganisationSyncKey is required when Scope school is used, otherwise it will be ignored


SitesType

Name

Description

Type

M/O

Site

Site where content will be shared

Complex type - array of SiteType

O

SiteType

Name

Description

Type

M/O

ID

Attribute

Int

M

OrganisationSyncKey

List of organisations where content will be shared

Complex type - array of Text

O

ElementPropertiesType

Name

Description

Type

M/O

Active

Whether extension instance is Active (available for all students)

Boolean

O

AssessmentScale

Assessment scale ID

Integer

O

DurationType

Name

Description

Type

M/O

DurationValue

The Duration provides the length of the period according to [ISO8601, 00], for example P3M for three months, PT3m58s for three minutes 58 seconds.

Text

M

Description

A optional description of the Duration can be provided for periods that are not well described by this scheme, for example "about half an hour". The description is given as a LangString.

Text

O



Scenario

Add scenario

Message schema

Update Extension Instance Schema
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="urn:message-schema"
elementFormDefault="qualified"
targetNamespace="urn:message-schema">
<xs:element name="Message" type="MessageType" />
<xs:complexType name="MessageType">
<xs:sequence>
<xs:element name="SiteId" minOccurs="0" maxOccurs="1" type="xs:int" />
<xs:element name="VendorId" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="36"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="UpdateExtensionInstance" type="UpdateExtensionInstanceElementType" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="UpdateExtensionInstanceElementType">
<xs:sequence>
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="ContentId" type="xs:int"/>
<xs:element name="ContentSyncKey" type="xs:string"/>
</xs:choice>
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="UserId" type="xs:int"/>
<xs:element name="UserSyncKey" type="xs:string"/>
</xs:choice>
<xs:element name="Title" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Metadata" type="MetadataType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Sharing" type="SharingType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Content" type="ContentType" minOccurs="0" maxOccurs="1"/>
<xs:element name="DisallowModification" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="ElementProperties" type="ElementPropertiesType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="FormatEnum">
<xs:restriction base="xs:string">
<xs:enumeration value="Any"/>
<xs:enumeration value="Audio"/>
<xs:enumeration value="Image"/>
<xs:enumeration value="Interactive"/>
<xs:enumeration value="Text"/>
<xs:enumeration value="Video"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ScopeEnum">
<xs:restriction base="xs:string">
<xs:enumeration value="Private"/>
<xs:enumeration value="School"/>
<xs:enumeration value="Site"/>
<xs:enumeration value="Community"/>
<xs:enumeration value="Custom"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="EducationalIntentEnum">
<xs:list>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Practice" />
<xs:enumeration value="Instructional" />
</xs:restriction>
</xs:simpleType>
</xs:list>
</xs:simpleType>
<xs:complexType name="MetadataType">
<xs:sequence>
<xs:element name="Description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="Language" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="Format" type="FormatEnum" minOccurs="0" maxOccurs="1"/>
<xs:element name="Keywords" type="KeywordsType" minOccurs="0" maxOccurs="1"/>
<xs:element name="LearningObjectives" type="LearningObjectivesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="IntendedEndUserRole" type="IntendedEndUserRoleEnum" minOccurs="0" maxOccurs="1"/>
<xs:element name="Grade" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="Duration" type="DurationType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ThumbnailUrl" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="EducationalIntent" type="EducationalIntentEnum" minOccurs="0" maxOccurs="1"/>
<xs:element name="HasFlashContent" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="IntendedAge" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="Publisher" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="ReadingGradeLevel" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="KnovationReadabilityScore" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="LexileScore" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SharingType">
<xs:sequence>
<xs:element name="Scope" type="ScopeEnum" minOccurs="0" maxOccurs="1" default="Private"/>
<xs:element name="OrganisationSyncKey" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="Sites" type="SitesType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SitesType">
<xs:sequence>
<xs:element name="Site" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="OrganisationSyncKey" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ID" type="xs:int" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="KeywordsType">
<xs:sequence>
<xs:element name="Keyword" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LearningObjectivesType">
<xs:sequence>
<xs:element name="LearningObjective" type="LearningObjectiveType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="LearningObjectiveType">
<xs:sequence>
<xs:element name="LearningObjectiveId" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="IntendedEndUserRoleEnum">
<xs:list>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Learner" />
<xs:enumeration value="Instructor" />
<xs:enumeration value="Mentor" />
</xs:restriction>
</xs:simpleType>
</xs:list>
</xs:simpleType>
<xs:complexType name="DurationType">
<xs:sequence>
<xs:element name="DurationValue" type="xs:string" minOccurs="1" maxOccurs="1"/>
<xs:element name="Description" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ContentType">
<xs:sequence>
<xs:any minOccurs="0" processContents="skip"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ElementPropertiesType">
<xs:sequence>
<xs:element name="Active" type="xs:boolean" minOccurs="0" maxOccurs="1" />
<xs:element name="AssessmentScale" type="xs:int" minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:schema>

Message content example (FileOrLink extension. Destination: course)

Update Extension Instance content
<Message xmlns="urn:message-schema">
<UpdateExtensionInstance>
<ContentSyncKey>LinkSyncKey</ContentSyncKey>
<UserId>6</UserId>
<Title>New link title</Title>
<Content>
<FileLinkContent>
<Description>This is a link to Google</Description>
<HideLink>true</HideLink>
<Link>http://www.google.com</Link>
</FileLinkContent>
</Content>
<ElementProperties>
<Active>true</Active>
</ElementProperties>
</UpdateExtensionInstance>
</Message>

Message content example (LTI extension. Destination: course)

Update Extension Instance content
<Message xmlns="urn:message-schema">
<UpdateExtensionInstance>
<ContentSyncKey>LtiSyncKey</ContentSyncKey>
<UserId>6</UserId>
<Title>Link to a website</Title>
<Content>
<LtiContent>
<XmlConfiguration>
<Url>http://www.edu-apps.org/tools/youtube/config.xml</Url>
</XmlConfiguration>
<Description>youtube LTI</Description>
<OpenIn>ExistingWindow</OpenIn>
</LtiContent>
</Content>
<ElementProperties>
<Active>true</Active>
<AssessmentScale>2</AssessmentScale>
</ElementProperties>
</UpdateExtensionInstance>
</Message>

Message content example (Page extension. Destination: My Library)

Update Extension Instance content
<Message xmlns="urn:message-schema">
<UpdateExtensionInstance>
<ContentSyncKey>PageSyncKey</ContentSyncKey>
<UserId>1</UserId>
<Title>new page title</Title>
<Metadata>
<Description>This is my new description for this extension instance</Description>
<Language>en-US</Language>
<Format>Interactive</Format>
<Keywords>
<Keyword>Keyword1</Keyword>
<Keyword>Keyword2</Keyword>
</Keywords>
<LearningObjectives>
<LearningObjective>
<LearningObjectiveId>ABC</LearningObjectiveId>
</LearningObjective>
</LearningObjectives>
</Metadata>
<Sharing>
<Scope>School</Scope>
<OrganisationSyncKey>SchoolA</OrganisationSyncKey>
</Sharing>
<Content>
<PageContent>
<ContentBlockSets>
<ContentBlockSet>
<ContentBlockImages>
<Title>Desert and tulips images</Title>
<Images>
<BlockImage>
<Title>Desert</Title>
<File>
<Id>1</Id>
</File>
</BlockImage>
<BlockImage>
<Title>Tulips</Title>
<File>
<Id>2</Id>
</File>
</BlockImage>
</Images>
</ContentBlockImages>
</ContentBlockSet>
</ContentBlockSets>
</PageContent>
</Content>
</UpdateExtensionInstance>
</Message>

Message content example (Assignment extension. Destination: My Library)

Update Extension Instance content
<Message xmlns="urn:message-schema">
<UpdateExtensionInstance>
<ContentId>4872</ContentId>
<UserId>400001</UserId>
<Content>
<AssignmentContent>
<Files>
<File>
<Id>90e49b77-2832-4966-98cb-4a746e501a31</Id>
<Name>file3.jpg</Name>
</File>
</Files>
<Text>Description text</Text>
</AssignmentContent>
</Content>
</UpdateExtensionInstance>
</Message>

Request example Page

Update extension instance example
Add message

Request example Assignment

Update extension instance example
<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.Services.Entities">
<soapenv:Header/>
<soapenv:Body>
<tem:AddMessage>
<tem:dataMessage>
<its:Data><![CDATA[
<Message xmlns="urn:message-schema">
<UpdateExtensionInstance>
<ContentId>4872</ContentId>
<UserId>400001</UserId>
<Content>
<AssignmentContent>
<Files>
<File>
<Id>90e49b77-2832-4966-98cb-4a746e501a31</Id>
<Name>file3.jpg</Name>
</File>
</Files>
<Text>Description text</Text>
</AssignmentContent>
</Content>
</UpdateExtensionInstance>
</Message>
]]></its:Data>
<its:Type>42</its:Type>
</tem:dataMessage>
</tem:AddMessage>
</soapenv:Body>
</soapenv:Envelope>

Output

Finished Status:

  1. Extension element was updated.

Warning Status:

  1. Unknown assessment (grade) ID - ""No Assessment"" assumed.

  2. It's not possible to change AssessmentScale: grading is already started.

  3. Learning objective with UniqueId='{0}' is not in the learning objective repository.

  4. Duration = [duration] can't be parsed

  5. Sharing Scope is not set to School, but still an Organisation SyncKey is given.

  6. Sharing can't be specified for course.

  7. Not all Intended age values are valid, value(s): {0} are skipped

  8. Not all Grade values are valid, value(s): {0} are skipped


Error Status:

  1. Message must contain valid ContentId/ContentSyncKey.

  2. Instance with specified ContentId/ContentSyncKey does not exist.

  3. Instance with specified ContentId/ContentSyncKey does not exist or is deleted.

  4. haring Scope is not set to School, but still an Organisation SyncKey is givenAn unknown error has occured.

  5. The User doesn't have access to my library functionality.

  6. Language [language] is not supported.

  7. The Instance is shared with a School, but no Organisation SyncKey is given.

  8. The given Organisation SyncKey is not valid.

  9. Your security settings don't allow you to perform that operation. Please contact administration to grant you an access to all organisation in this site.

  10. Your security settings don't allow you to perform that operation. Please contact administration to grant you an access to [OrganisationName] organisation.

  11. The Instance is shared using custom sharing scope, but other sites usage is not allowed.

  12. The Instance is shared using custom sharing scope, but no Site elements are specified.

  13. The Instance is shared using custom sharing scope, but following Sites: [comma separated sites] are not permitted.

  14. No valid extension id is given.

  15. Xml validation exception: [validation exception]

  16. Can't find element for specified ContentId/ContentSyncKey.

  17. Can't update deleted element for specified ContentId/ContentSyncKey.

Before message is processed the processor will validate the message content and state of objects referred in it. These are validation rules:

  1. Input matches the schema above (content needs to match extension specific content schema).

  2. Check the SyncKey is unqiue.

  3. User must exist.

  4. User must not be external.

  5. User must not be deleted.

  6. When location is library, user must have access to my library functionality

  7. When location Course is provided, course id or course SyncKey must be provided.

  8. If specified: Course must exist.

  9. If specified: Course must not be external.

  10. If specified: Course must not be deleted.

  11. If specified: Course must not be archived.

  12. If specified: ParentSyncKey must be the SyncKey of a folder within the course.

  13. If specified: ParentSyncKey must be a folder.

  14. If specified: ParentSyncKey must not be deleted.

  15. If created in a course or shared within organisation: Consumer must have access to organisation where course is created..

  16. If sharing with site: Consumer must have access to site

  17. If sharing with school: OrganisationSyncKey must be provided

  18. If specified: Learning objective id must be in repository.

  19. If specified language does not match languages defined in platform.

  20. If specified validate sharing rules.

  21. If specified: Assessment scale must exist and belong to specified course.

  22. Instance with specified ContentId/ContentSyncKey is not original instance from Library.

Warnings

  1. Sharing can't be specified for course instances (when Location is Course).

  2. OrganisationSyncKey is provided and Sharing scope is not School

Handling files within Page content blocks

For more details on how to handle file uploads, please see Handling rich content and files and FileStreamService.svc methods and messages, the supported file upload method(s) depends on the extension supporting it.