POST restapi/personal/courses/activeplans/v1?startDate={startDate}&endDate={endDate}

Gets information about the courses with the specified sync keys and having active lesson plans within the specified dates range.

Request Information

URI Parameters

Name	Description	Type	Additional information
startDate		date	Required
endDate		date	Required

Body Parameters

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

List of objects containing course id, its name and the ids of active lesson plans.

Collection of Itslearning.RestApi.Entities.Personal.CourseWithActivePlans

Name	Description	Type	Additional information
CourseId	Id of the course.	integer	None.
CourseSyncKey	Course synchronization key.	string	None.
CourseTitle	Title of the course.	string	None.
PlanIds	List of active plans' ids.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CourseId": 1,
    "CourseSyncKey": "sample string 2",
    "CourseTitle": "sample string 3",
    "PlanIds": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "CourseId": 1,
    "CourseSyncKey": "sample string 2",
    "CourseTitle": "sample string 3",
    "PlanIds": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCourseWithActivePlans xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CourseWithActivePlans>
    <CourseId>1</CourseId>
    <CourseSyncKey>sample string 2</CourseSyncKey>
    <CourseTitle>sample string 3</CourseTitle>
    <PlanIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PlanIds>
  </CourseWithActivePlans>
  <CourseWithActivePlans>
    <CourseId>1</CourseId>
    <CourseSyncKey>sample string 2</CourseSyncKey>
    <CourseTitle>sample string 3</CourseTitle>
    <PlanIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PlanIds>
  </CourseWithActivePlans>
</ArrayOfCourseWithActivePlans>