Read.WarningLetter

Reads an array warning letters that have the status "Created" (it means that they have been published in itslearning), when they are read, the status is set to "Received".

Input parameters

Name

Description

Type

M/O

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

PageIndex

Starts on 0 (0 is default if nothing is specified). Refers to the page number.
With default values for PageSize, 0 returns rows 1-100, 1 returns 101-200, 100 returns 10001-10100 etc

Integer

O

PageSize

Size of the array that will be returned (max 100, default 100)

Integer

O

Message 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.Model.ServiceEntities">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadWarningLetter>
<tem:request>
<its:PageIndex>0</its:PageIndex>
<its:PageSize>25</its:PageSize>
</tem:request>
</tem:ReadWarningLetter>
</soapenv:Body>
</soapenv:Envelope>

Output

The method returns an array of warning letters.

If the warning letter is not connected to a course, the CourseId property will be 0 and CourseSyncKey and CourseTitle properties will be empty.

Message response example:

<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>2012-11-05T15:15:19.514Z</u:Created>
<u:Expires>2012-11-05T15:20:19.514Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<ReadWarningLetterResponse xmlns="http://tempuri.org/">
<ReadWarningLetterResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.WarningLetter" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CurrentPageIndex xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">0</CurrentPageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">25</PageSize>
<Total xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">2</Total>
<a:WarningLetters>
<a:WarningLetter>
<a:AuthorId>1</a:AuthorId>
<a:AuthorSyncKey>Mikael Karlsson</a:AuthorSyncKey>
<a:CourseId>1</a:CourseId>
<a:CourseSyncKey>synccourseid</a:CourseSyncKey>
<a:Id>3</a:Id>
<a:RecipientId>100</a:RecipientId>
<a:RecipientSyncKey/>
<a:Text><![CDATA[<table>.. Some text ..</table>]]</a:Text>
<a:Title>Final warning</a:Title>
<a:CourseTitle>Maths</a:CourseTitle>
<a:OrganisationSyncKey i:nil="true"/>
<a:PublishDate>2013-05-01T11:59:48</a:PublishDate>
</a:WarningLetter>
<a:WarningLetter>
<a:AuthorId>1</a:AuthorId>
<a:AuthorSyncKey>Mikael Karlsson</a:AuthorSyncKey>
<a:CourseId>3</a:CourseId>
<a:CourseSyncKey/>
<a:Id>4</a:Id>
<a:RecipientId>100</a:RecipientId>
<a:RecipientSyncKey/>
<a:Text><![CDATA[<table>.. Some other text ..</table>]]</a:Text>
<a:Title>Title of the letter</a:Title>
<a:CourseTitle>Training</a:CourseTitle>
<a:OrganisationSyncKey>site_abc</a:OrganisationSyncKey>
<a:PublishDate>2013-05-01T11:40:18</a:PublishDate>
</a:WarningLetter>
<a:WarningLetter>
<a:AuthorId>1</a:AuthorId>
<a:AuthorSyncKey>Mikael Karlsson</a:AuthorSyncKey>
<a:CourseId>0</a:CourseId>
<a:CourseSyncKey/>
<a:Id>5</a:Id>
<a:RecipientId>105</a:RecipientId>
<a:RecipientSyncKey/>
<a:Text><![CDATA[<table>.. Some other text ..</table>]]</a:Text>
<a:Title>Title of the letter</a:Title>
<a:CourseTitle/>
<a:OrganisationSyncKey>site_abc</a:OrganisationSyncKey>
<a:PublishDate>2013-05-01T11:41:25</a:PublishDate>
</a:WarningLetter>
</a:WarningLetters>
</ReadWarningLetterResult>
</ReadWarningLetterResponse>
</s:Body>
</s:Envelope>