GET restapi/personal/planner/v1?courseId={courseId}&startDate={startDate}&stopDate={stopDate}

Get previews of plans for the specified course.

By supplying a time period parameters ( and ) one can get plans only within this particular time period. Plan will be included into the result if it starts or ends within the period. If period is not supplied the list will contain all plans for the course.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	[Required] The course identifier. Required to get a plans.	integer	Required
startDate	[Optional] The start date for plans. Time zone is UTC. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.	date	None.
stopDate	[Optional] The plan stop date for plans. Time zone is UTC. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.	date	None.

Body Parameters

None.

Response Information

Resource Description

This method returns a list of plans for the specified course.

EntityListOfItslearning.RestApi.Entities.Planner.PlanPreview

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.Planner.PlanPreview	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "PlanName": "sample string 1",
      "PlanDescription": "sample string 2",
      "Start": "2025-06-16T07:38:49Z",
      "Stop": "2025-06-16T07:38:49Z",
      "ClassHours": 3,
      "PlanId": 1,
      "TopicId": 2,
      "Order": 3,
      "LocationId": 4,
      "LocationType": "Course",
      "LocationTitle": "sample string 5",
      "LocationColor": "sample string 6",
      "TopicColor": "sample string 7"
    },
    {
      "PlanName": "sample string 1",
      "PlanDescription": "sample string 2",
      "Start": "2025-06-16T07:38:49Z",
      "Stop": "2025-06-16T07:38:49Z",
      "ClassHours": 3,
      "PlanId": 1,
      "TopicId": 2,
      "Order": 3,
      "LocationId": 4,
      "LocationType": "Course",
      "LocationTitle": "sample string 5",
      "LocationColor": "sample string 6",
      "TopicColor": "sample string 7"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <PlanPreview>
      <LocationColor>sample string 6</LocationColor>
      <LocationId>4</LocationId>
      <LocationTitle>sample string 5</LocationTitle>
      <LocationType>Course</LocationType>
      <Order>3</Order>
      <PlanId>1</PlanId>
      <TopicColor>sample string 7</TopicColor>
      <TopicId>2</TopicId>
      <ClassHours>3</ClassHours>
      <PlanDescription>sample string 2</PlanDescription>
      <PlanName>sample string 1</PlanName>
      <Start>2025-06-16T07:38:49Z</Start>
      <Stop>2025-06-16T07:38:49Z</Stop>
    </PlanPreview>
    <PlanPreview>
      <LocationColor>sample string 6</LocationColor>
      <LocationId>4</LocationId>
      <LocationTitle>sample string 5</LocationTitle>
      <LocationType>Course</LocationType>
      <Order>3</Order>
      <PlanId>1</PlanId>
      <TopicColor>sample string 7</TopicColor>
      <TopicId>2</TopicId>
      <ClassHours>3</ClassHours>
      <PlanDescription>sample string 2</PlanDescription>
      <PlanName>sample string 1</PlanName>
      <Start>2025-06-16T07:38:49Z</Start>
      <Stop>2025-06-16T07:38:49Z</Stop>
    </PlanPreview>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>