PUT restapi/personal/element/embedded/{elementId}/v1

Update embedded element.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
elementId

integer

Required

Body Parameters

Itsolutions.Itslearning.Web.RestApi.Personal.EmbeddedElement.Models.UpdateEmbeddedElementRequest
NameDescriptionTypeAdditional information
ElementProperties

Element properties.

Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.ElementProperties

None.

ElementSupportsAssessment

Element supports assessment.

Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.ElementSupportsAssessment

None.

Request Formats

application/json, text/json

Sample:
{
  "ElementProperties": {
    "Title": "sample string 1",
    "Visibility": {
      "IsActive": true,
      "ActiveFrom": "2026-05-13T09:26:05Z",
      "ActiveTo": "2026-05-13T09:26:05Z"
    },
    "AssignTo": {
      "ParticipantIds": [
        1,
        2
      ],
      "GroupIds": [
        1,
        2
      ],
      "GroupName": "sample string 1"
    },
    "LearningObjectivesIds": [
      1,
      2
    ]
  },
  "ElementSupportsAssessment": {
    "DeadlineSettings": {
      "Deadline": "2026-05-13T09:26:05Z",
      "IsSubmissionAfterDeadlineAllowed": true
    },
    "AssessmentStatusId": 1,
    "AssessmentId": 1,
    "MaxScore": 1.1,
    "IsAssessmentVisibleForStudents": true,
    "AddToAssessmentRecord": true,
    "AssessmentRecordCategoryId": 1,
    "TermId": 1,
    "IsAnonymous": true,
    "IsHomework": true,
    "IsMandatory": true,
    "IsOptional": true,
    "CompletionMode": "NotApplicable",
    "ExcludeFromTeacherTaskList": true,
    "IncludeToTeacherTaskList": true
  }
}

application/xml, text/xml

Sample:
<UpdateEmbeddedElementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.EmbeddedElement.Models">
  <ElementProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:AssignTo>
      <d2p1:GroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:GroupIds>
      <d2p1:GroupName>sample string 1</d2p1:GroupName>
      <d2p1:ParticipantIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ParticipantIds>
    </d2p1:AssignTo>
    <d2p1:LearningObjectivesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:LearningObjectivesIds>
    <d2p1:Title>sample string 1</d2p1:Title>
    <d2p1:Visibility>
      <d2p1:ActiveFrom>2026-05-13T09:26:05Z</d2p1:ActiveFrom>
      <d2p1:ActiveTo>2026-05-13T09:26:05Z</d2p1:ActiveTo>
      <d2p1:IsActive>true</d2p1:IsActive>
    </d2p1:Visibility>
  </ElementProperties>
  <ElementSupportsAssessment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:AddToAssessmentRecord>true</d2p1:AddToAssessmentRecord>
    <d2p1:AssessmentId>1</d2p1:AssessmentId>
    <d2p1:AssessmentRecordCategoryId>1</d2p1:AssessmentRecordCategoryId>
    <d2p1:AssessmentStatusId>1</d2p1:AssessmentStatusId>
    <d2p1:CompletionMode>NotApplicable</d2p1:CompletionMode>
    <d2p1:DeadlineSettings>
      <d2p1:Deadline>2026-05-13T09:26:05Z</d2p1:Deadline>
      <d2p1:IsSubmissionAfterDeadlineAllowed>true</d2p1:IsSubmissionAfterDeadlineAllowed>
    </d2p1:DeadlineSettings>
    <d2p1:ExcludeFromTeacherTaskList>true</d2p1:ExcludeFromTeacherTaskList>
    <d2p1:IncludeToTeacherTaskList>true</d2p1:IncludeToTeacherTaskList>
    <d2p1:IsAnonymous>true</d2p1:IsAnonymous>
    <d2p1:IsAssessmentVisibleForStudents>true</d2p1:IsAssessmentVisibleForStudents>
    <d2p1:IsHomework>true</d2p1:IsHomework>
    <d2p1:IsMandatory>true</d2p1:IsMandatory>
    <d2p1:IsOptional>true</d2p1:IsOptional>
    <d2p1:MaxScore>1.1</d2p1:MaxScore>
    <d2p1:TermId>1</d2p1:TermId>
  </ElementSupportsAssessment>
</UpdateEmbeddedElementRequest>

application/x-www-form-urlencoded

Sample:
No sample available

Response Information

Resource Description

Itsolutions.Itslearning.Web.RestApi.Personal.EmbeddedElement.Models.CreateUpdateEmbeddedElementResponse
NameDescriptionTypeAdditional information
ViewLearningToolElementUrl

Url to view page.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ViewLearningToolElementUrl": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateUpdateEmbeddedElementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.EmbeddedElement.Models">
  <ViewLearningToolElementUrl>sample string 1</ViewLearningToolElementUrl>
</CreateUpdateEmbeddedElementResponse>