Read.Course.Planner.Lessonse

Reads the planner lessons for the specified course. Both the course setting ("Planner") and customer setting ("Use new planner") must be enabled for this method to work.

Input parameters

Name

Description

Type

Mandatory/Optional

SiteId

Site where action will be executed.

Integer

Optional

VendorId

VendorId. Currently not used.

Text

Optional

PageIndex

Index of the requested page. This defaults to 0.

Integer

O

PageSize

Size of the requested page. The default and limit is 100.

Integer

O

CourseId

Course identifier of the course to get the lessons for.

NOTE: You are not allowed to enter both CourseId and CourseSyncKey.

Integer

M/O

CourseSyncKey

SyncKey of the course to get the lessons for.

NOTE: You are not allowed to enter both CourseId and CourseSyncKey.

String

M/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" xmlns:its1="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CoursePlannerLessons">
<soapenv:Header/>
<soapenv:Body>
<tem:ReadCoursePlannerLessons>
<tem:request>
<its:PageIndex>0</its:PageIndex>
<its:PageSize>1</its:PageSize>
<its1:CourseId>3</its1:CourseId>
</tem:request>
</tem:ReadCoursePlannerLessons>
</soapenv:Body>
</soapenv:Envelope>

Output parameters

Name

Description

Type

Active

Specifies whether or not it is an active lesson.

Boolean

Title

The title of the lesson.

String

Description

The lesson outline.

String

StartDate

Start date of the lesson (if specified).

Date

EndDate

End date of the lesson (if specified).

Date

LessonId

Identifier of the lesson.

Integer

TopicId

The identifier of the associated topic (if any).

Integer

TopicTitle

The name of the associoated topic (if any).

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>2012-12-20T08:50:06.440Z</u:Created>
<u:Expires>2012-12-20T08:55:06.440Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<ReadCoursePlannerLessonsResponse xmlns="http://tempuri.org/">
<ReadCoursePlannerLessonsResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CoursePlannerLessons" 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">1</PageSize>
<Total xmlns="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities">2</Total>
<a:Lessons>
<a:PlannerLesson>
<a:Active>true</a:Active>
<a:Description>Outline of lesson</a:Description>
<a:EndDate>2012-12-28T07:00:00</a:EndDate>
<a:LessonId>1</a:LessonId>
<a:StartDate>2012-12-21T07:00:00</a:StartDate>
<a:Title>Introduction</a:Title>
<a:TopicId>1</a:TopicId>
<a:TopicTitle>Math</a:TopicTitle>
</a:PlannerLesson>
</a:Lessons>
</ReadCoursePlannerLessonsResult>
</ReadCoursePlannerLessonsResponse>
</s:Body>
</s:Envelope>

Error states

In the following cases it will return an error:

  • The requested course does not exist.

  • The requested course has been deleted.

  • The requested course exists, but belongs to an organisation the requester does not have access to.

  • The requester supplied both a CourseId and CourseSyncKey.

  • The requested course does not have the planner enabled.