GET restapi/personal/children/{childId}/plans/v1?startDate={startDate}&stopDate={stopDate}&onlyWithoutDates={onlyWithoutDates}&PageIndex={PageIndex}&PageSize={PageSize}

Gets a list of plans assigned to the child.

Request Information

URI Parameters

Name	Description	Type	Additional information
childId	[Required] The child person identifier.	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.
onlyWithoutDates	[Optional] If true, then plans with no date are returned.	boolean	Default value is False
PageIndex		integer	None.
PageSize		integer	None.

Body Parameters

None.

Response Information

Resource Description

This method returns a collection of entities .

EntityListOfItslearning.RestApi.Entities.Planner.PlanPreviewV2

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.Planner.PlanPreviewV2	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-25T13:21:02Z",
      "Stop": "2025-06-25T13:21:02Z",
      "TopicName": "sample string 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-25T13:21:02Z",
      "Stop": "2025-06-25T13:21:02Z",
      "TopicName": "sample string 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>
    <PlanPreviewV2>
      <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>
      <PlanDescription>sample string 2</PlanDescription>
      <PlanName>sample string 1</PlanName>
      <Start>2025-06-25T13:21:02Z</Start>
      <Stop>2025-06-25T13:21:02Z</Stop>
      <TopicName>sample string 3</TopicName>
    </PlanPreviewV2>
    <PlanPreviewV2>
      <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>
      <PlanDescription>sample string 2</PlanDescription>
      <PlanName>sample string 1</PlanName>
      <Start>2025-06-25T13:21:02Z</Start>
      <Stop>2025-06-25T13:21:02Z</Stop>
      <TopicName>sample string 3</TopicName>
    </PlanPreviewV2>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>