Link
Input parameters
Message |
|||
Name |
Description |
Type |
M/O |
Description |
Description shown for the link |
Text |
O |
EmbedLinkTarget |
Embed the link target on the page in itslearning. The link needs to be secure (https) to be able to have this a true value. |
Boolean, true/false |
O |
Link |
Link url. Should be less than or equal to 2000 characters. |
Text |
M |
Content example
<
LinkContent
>
<
Description
>This is a link to Google</
Description
>
<
EmbedLinkTarget
>true</
EmbedLinkTarget
>
<
Link
>
http://www.google.com
</
Link
>
</
LinkContent
>
Full request 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>
<!--Optional:-->
<
tem
:dataMessage>
<!--Optional:-->
<
its
:Data>
<![CDATA[<?xml version="1.0" encoding="utf-8"?>
<Message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:message-schema">
<CreateExtensionInstance>
<Location>Course</Location>
<ExtensionId>5010</ExtensionId>
<CourseId>1</CourseId>
<UserId>1</UserId>
<Title>This is a link to Google</Title>
<Content>
<LinkContent>
<Description>This is a link to Google</Description>
<EmbedLinkTarget>true</EmbedLinkTarget>
<Link>http://www.google.com</Link>
</LinkContent>
</Content>
<ElementProperties>
<Active>false</Active>
</ElementProperties>
</CreateExtensionInstance>
</Message>
]]>
</
its
:Data>
<!--Optional:-->
<
its
:Type>37</
its
:Type>
</
tem
:dataMessage>
</
tem
:AddMessage>
</
soapenv
:Body>
</
soapenv
:Envelope>
Errors
-
Invalid content: url is not supplied
-
Invalid uri scheme. Acceptable values are 'http' and 'https'.
-
Provided URL {Link} is not valid
-
Invalid content: the length of the url is too long (the maximum length is 2000 characters).