POST restapi/personal/planner/targetCourse/{targetCourseId}/targetTopic/{targetTopicId}/targetPlan/{targetPlanId}/v1

Adds shared plan elements to the course plan.

Request Information

URI Parameters

Name	Description	Type	Additional information
targetCourseId	ID of the course where the elements are added.	integer	Required
targetTopicId	ID of the course topic where the elements are added. Can be 0.	integer	Required
targetPlanId	ID of the course plan where the elements are added.	integer	Required

Body Parameters

Payload contains element IDs and flag indicating if only existing in the target course learning objectives can be used.

Itsolutions.Itslearning.Web.RestApi.Internal.Models.Planner.ShareablePlanner.AddSharedResourcesToCoursePlanRequest

Name	Description	Type	Additional information
Elements	Elements to be added.	Collection of Itslearning.Platform.RestApi.Sdk.ItslEntities.Planner.PlanElement	None.
AddOnlyExistingInCourseLearningObjectives	Indicates if only existing in the target course learning objectives can be used.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Elements": [
    {
      "LearningObjectInstanceId": 1,
      "ExtensionId": 2,
      "AuthorPersonId": 3,
      "AuthorName": "sample string 4",
      "SharedWith": "sample string 5",
      "SharingScope": 0,
      "VendorDefaultName": "sample string 6",
      "VendorAuthorName": "sample string 7",
      "ElementLearningObjectives": [
        1,
        2
      ],
      "IconTypeId": 1,
      "IconsVersion": 8,
      "ElementId": 9,
      "Title": "sample string 10",
      "LearningObjectId": 11,
      "LearningToolType": 0,
      "Order": 12
    },
    {
      "LearningObjectInstanceId": 1,
      "ExtensionId": 2,
      "AuthorPersonId": 3,
      "AuthorName": "sample string 4",
      "SharedWith": "sample string 5",
      "SharingScope": 0,
      "VendorDefaultName": "sample string 6",
      "VendorAuthorName": "sample string 7",
      "ElementLearningObjectives": [
        1,
        2
      ],
      "IconTypeId": 1,
      "IconsVersion": 8,
      "ElementId": 9,
      "Title": "sample string 10",
      "LearningObjectId": 11,
      "LearningToolType": 0,
      "Order": 12
    }
  ],
  "AddOnlyExistingInCourseLearningObjectives": true
}

application/xml, text/xml

Sample:

<AddSharedResourcesToCoursePlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Internal.Models.Planner.ShareablePlanner">
  <AddOnlyExistingInCourseLearningObjectives>true</AddOnlyExistingInCourseLearningObjectives>
  <Elements xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itslearning.Platform.RestApi.Sdk.ItslEntities.Planner">
    <d2p1:PlanElement>
      <d2p1:ElementId>9</d2p1:ElementId>
      <d2p1:LearningObjectId>11</d2p1:LearningObjectId>
      <d2p1:LearningToolType>LearningResource</d2p1:LearningToolType>
      <d2p1:Order>12</d2p1:Order>
      <d2p1:Title>sample string 10</d2p1:Title>
      <d2p1:AuthorName>sample string 4</d2p1:AuthorName>
      <d2p1:AuthorPersonId>3</d2p1:AuthorPersonId>
      <d2p1:ElementLearningObjectives xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ElementLearningObjectives>
      <d2p1:ExtensionId>2</d2p1:ExtensionId>
      <d2p1:IconTypeId>1</d2p1:IconTypeId>
      <d2p1:IconsVersion>8</d2p1:IconsVersion>
      <d2p1:LearningObjectInstanceId>1</d2p1:LearningObjectInstanceId>
      <d2p1:SharedWith>sample string 5</d2p1:SharedWith>
      <d2p1:SharingScope>None</d2p1:SharingScope>
      <d2p1:VendorAuthorName>sample string 7</d2p1:VendorAuthorName>
      <d2p1:VendorDefaultName>sample string 6</d2p1:VendorDefaultName>
    </d2p1:PlanElement>
    <d2p1:PlanElement>
      <d2p1:ElementId>9</d2p1:ElementId>
      <d2p1:LearningObjectId>11</d2p1:LearningObjectId>
      <d2p1:LearningToolType>LearningResource</d2p1:LearningToolType>
      <d2p1:Order>12</d2p1:Order>
      <d2p1:Title>sample string 10</d2p1:Title>
      <d2p1:AuthorName>sample string 4</d2p1:AuthorName>
      <d2p1:AuthorPersonId>3</d2p1:AuthorPersonId>
      <d2p1:ElementLearningObjectives xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ElementLearningObjectives>
      <d2p1:ExtensionId>2</d2p1:ExtensionId>
      <d2p1:IconTypeId>1</d2p1:IconTypeId>
      <d2p1:IconsVersion>8</d2p1:IconsVersion>
      <d2p1:LearningObjectInstanceId>1</d2p1:LearningObjectInstanceId>
      <d2p1:SharedWith>sample string 5</d2p1:SharedWith>
      <d2p1:SharingScope>None</d2p1:SharingScope>
      <d2p1:VendorAuthorName>sample string 7</d2p1:VendorAuthorName>
      <d2p1:VendorDefaultName>sample string 6</d2p1:VendorDefaultName>
    </d2p1:PlanElement>
  </Elements>
</AddSharedResourcesToCoursePlanRequest>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.