GET restapi/personal/children/{childId}/plans/{planId}/v1

Gets the child's single plan details.

Returns HTTP status 404 not found, if the plan does not exist for the user. It will only return plan the user has access to.

Request Information

URI Parameters

Name	Description	Type	Additional information
childId	[Required] The child identifier.	integer	Required
planId	[Required] The plan identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

This method returns plan details .

Itslearning.RestApi.Entities.Planner.Plan

Name	Description	Type	Additional information
ThumbnailColumn	The 'Thumbnail' plan column data.	Itslearning.RestApi.Entities.Planner.PlanThumbnailColumn	None.
NameColumn	The 'Plan' plan column data.	Itslearning.RestApi.Entities.Planner.PlanColumn	None.
DescriptionColumn	The 'Description' plan column data.	Itslearning.RestApi.Entities.Planner.PlanColumn	None.
DateColumn	The 'Date' plan column data.	Itslearning.RestApi.Entities.Planner.PlanDateColumn	None.
ClassHoursColumn	The 'Class hours' plan column data.	Itslearning.RestApi.Entities.Planner.PlanClassHoursColumn	None.
LearningObjectivesColumn	The 'Learning objectives' plan column data.	Itslearning.RestApi.Entities.Planner.PlanLearningObjectivesColumn	None.
ResourcesColumn	The 'Resources' plan column data.	Itslearning.RestApi.Entities.Planner.PlanElementsColumn	None.
ActivitiesColumn	The 'Activities' plan column data.	Itslearning.RestApi.Entities.Planner.PlanElementsColumn	None.
ElementsColumn	The 'Resources and activities' plan column data.	Itslearning.RestApi.Entities.Planner.PlanElementsColumn	None.
Columns	The list of custom columns for plan.	Collection of Itslearning.RestApi.Entities.Planner.PlanColumn	None.
PlanId	The unique id for plan, in scope of a site (itslearning customer).	integer	None.
TopicId	The id of topic.	integer	None.
Order	The plan order.	integer	None.
LocationId	The plan location identifier.	integer	None.
LocationType	The plan location type.	Itslearning.RestApi.Entities.LocationType	None.
LocationTitle	The plan location title.	string	None.
LocationColor	The location color (e.g. #ffffff).	string	None.
TopicColor	The topic color (e.g. #ffffff).	string	None.
TopicName	The topic name.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TopicName": "sample string 1",
  "ThumbnailColumn": {
    "FileUrl": "sample string 1",
    "Name": "sample string 2",
    "Order": 3,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "NameColumn": {
    "Value": "sample string 1",
    "Name": "sample string 2",
    "Order": 3,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "DescriptionColumn": {
    "Value": "sample string 1",
    "Name": "sample string 2",
    "Order": 3,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "DateColumn": {
    "StartDate": "2025-06-18T13:54:23Z",
    "StopDate": "2025-06-18T13:54:23Z",
    "Name": "sample string 1",
    "Order": 2,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "ClassHoursColumn": {
    "ClassHours": 1,
    "Name": "sample string 2",
    "Order": 3,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "LearningObjectivesColumn": {
    "LearningObjectives": [
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "RepositoryId": 1
      },
      {
        "Id": 1,
        "Title": "sample string 2",
        "Description": "sample string 3",
        "RepositoryId": 1
      }
    ],
    "Name": "sample string 1",
    "Order": 2,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "ResourcesColumn": {
    "Elements": [
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      },
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      }
    ],
    "Name": "sample string 1",
    "Order": 2,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "ActivitiesColumn": {
    "Elements": [
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      },
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      }
    ],
    "Name": "sample string 1",
    "Order": 2,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "ElementsColumn": {
    "Elements": [
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      },
      {
        "Order": 1,
        "ElementId": 2,
        "ElementType": "Unknown",
        "Title": "sample string 3",
        "Url": "sample string 4",
        "ContentUrl": "sample string 5",
        "IconUrl": "sample string 6",
        "LearningToolId": 7,
        "Homework": true
      }
    ],
    "Name": "sample string 1",
    "Order": 2,
    "LocalizedName": {
      "LocalizedKey": "sample string 1",
      "LocalizedArgs": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "Columns": [
    {
      "Value": "sample string 1",
      "Name": "sample string 2",
      "Order": 3,
      "LocalizedName": {
        "LocalizedKey": "sample string 1",
        "LocalizedArgs": [
          "sample string 1",
          "sample string 2"
        ]
      }
    },
    {
      "Value": "sample string 1",
      "Name": "sample string 2",
      "Order": 3,
      "LocalizedName": {
        "LocalizedKey": "sample string 1",
        "LocalizedArgs": [
          "sample string 1",
          "sample string 2"
        ]
      }
    }
  ],
  "PlanId": 1,
  "TopicId": 2,
  "Order": 3,
  "LocationId": 4,
  "LocationType": "Course",
  "LocationTitle": "sample string 5",
  "LocationColor": "sample string 6",
  "TopicColor": "sample string 7"
}

application/xml, text/xml

Sample:

<Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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>
  <ActivitiesColumn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Planner">
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 1</Name>
    <Order>2</Order>
    <d2p1:Elements>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
    </d2p1:Elements>
  </ActivitiesColumn>
  <ClassHoursColumn>
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 2</Name>
    <Order>3</Order>
    <ClassHours>1</ClassHours>
  </ClassHoursColumn>
  <Columns>
    <PlanColumn>
      <LocalizedName>
        <LocalizedArgs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </LocalizedArgs>
        <LocalizedKey>sample string 1</LocalizedKey>
      </LocalizedName>
      <Name>sample string 2</Name>
      <Order>3</Order>
      <Value>sample string 1</Value>
    </PlanColumn>
    <PlanColumn>
      <LocalizedName>
        <LocalizedArgs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </LocalizedArgs>
        <LocalizedKey>sample string 1</LocalizedKey>
      </LocalizedName>
      <Name>sample string 2</Name>
      <Order>3</Order>
      <Value>sample string 1</Value>
    </PlanColumn>
  </Columns>
  <DateColumn>
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 1</Name>
    <Order>2</Order>
    <StartDate>2025-06-18T13:54:23Z</StartDate>
    <StopDate>2025-06-18T13:54:23Z</StopDate>
  </DateColumn>
  <DescriptionColumn>
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 2</Name>
    <Order>3</Order>
    <Value>sample string 1</Value>
  </DescriptionColumn>
  <ElementsColumn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Planner">
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 1</Name>
    <Order>2</Order>
    <d2p1:Elements>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
    </d2p1:Elements>
  </ElementsColumn>
  <LearningObjectivesColumn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Planner">
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 1</Name>
    <Order>2</Order>
    <d2p1:LearningObjectives>
      <PlanLearningObjective>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <RepositoryId>1</RepositoryId>
        <Title>sample string 2</Title>
      </PlanLearningObjective>
      <PlanLearningObjective>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <RepositoryId>1</RepositoryId>
        <Title>sample string 2</Title>
      </PlanLearningObjective>
    </d2p1:LearningObjectives>
  </LearningObjectivesColumn>
  <NameColumn>
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 2</Name>
    <Order>3</Order>
    <Value>sample string 1</Value>
  </NameColumn>
  <ResourcesColumn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Planner">
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 1</Name>
    <Order>2</Order>
    <d2p1:Elements>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
      <PlanElement>
        <ContentUrl>sample string 5</ContentUrl>
        <ElementId>2</ElementId>
        <ElementType>Unknown</ElementType>
        <Homework>true</Homework>
        <IconUrl>sample string 6</IconUrl>
        <LearningToolId>7</LearningToolId>
        <Title>sample string 3</Title>
        <Url>sample string 4</Url>
        <Order>1</Order>
      </PlanElement>
    </d2p1:Elements>
  </ResourcesColumn>
  <ThumbnailColumn>
    <LocalizedName>
      <LocalizedArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </LocalizedArgs>
      <LocalizedKey>sample string 1</LocalizedKey>
    </LocalizedName>
    <Name>sample string 2</Name>
    <Order>3</Order>
    <FileUrl>sample string 1</FileUrl>
  </ThumbnailColumn>
  <TopicName>sample string 1</TopicName>
</Plan>