PUT restapi/personal/library/pages/{learningObjectInstanceId}/contentblocks/images/{contentBlockId}/v1

Updates images content block.

Request Information

URI Parameters

Name	Description	Type	Additional information
learningObjectInstanceId	The unique identifier of the page element.	integer	Required
contentBlockId	The unique identifier of the content block.	integer	Required

Body Parameters

The image content block update request.

Itsolutions.Itslearning.Web.RestApi.Personal.Page.Requests.UpdateContentBlockImagesRequestUI

Name	Description	Type	Additional information
NewImages	Images to add to the content block.	Collection of Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.Requests.ImageItem	None.
DeletedImageIds	Image IDs to delete from the content block.	Collection of integer	None.
UpdatedImages	Images that should be updated in the content block.	Collection of Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.ImageMetaData	None.
ContentBlockId	The unique identifier for the content block.	integer	None.
Type	The type of the content block (e.g. "text", "image", "files", "rss", "poll"). Defaults to an empty string.	string	None.
Title	The title of the content block. Defaults to an empty string.	string	None.
Order	The display order of the content block within its Layout Zone. Lower values appear first.	integer	None.
LayoutZone	The layout zone where the content block should be placed (e.g. "Left", "Right"). Determines the positioning within the page layout.	string	None.
Color	The color of the content block.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "newImages": [
    {
      "imageFile": {
        "fileRepoId": "11cd6a0f-ddac-4452-884c-1be302d4f0b3",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "largeImageFile": {
        "fileRepoId": "51638dc6-8d9a-420d-ac9a-1ffe2fc97549",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "mediumImageFile": {
        "fileRepoId": "21aed93f-b8cd-43ee-a18a-c5a73c24b996",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "smallImageFile": {
        "fileRepoId": "93ffb001-7b1f-46e4-9c58-1e67e4d2c14b",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "altText": "sample string 1",
      "caption": "sample string 2"
    },
    {
      "imageFile": {
        "fileRepoId": "0e43ce62-18e5-478a-b2ce-caebe72f6fba",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "largeImageFile": {
        "fileRepoId": "9d3f7793-b9b4-400c-a85b-c83c2fa09d7a",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "mediumImageFile": {
        "fileRepoId": "514e1b1a-ef28-439d-924e-a4acbadfa01f",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "smallImageFile": {
        "fileRepoId": "2fce0452-6ecd-4348-a692-c116a7b7457c",
        "signedFileRepoId": "sample string 2",
        "name": "sample string 3",
        "mimeType": "sample string 4"
      },
      "altText": "sample string 1",
      "caption": "sample string 2"
    }
  ],
  "deletedImageIds": [
    1,
    2
  ],
  "updatedImages": [
    {
      "imageId": 1,
      "altText": "sample string 2",
      "caption": "sample string 3"
    },
    {
      "imageId": 1,
      "altText": "sample string 2",
      "caption": "sample string 3"
    }
  ],
  "contentBlockId": 1,
  "type": "sample string 2",
  "title": "sample string 3",
  "order": 4,
  "layoutZone": "sample string 5",
  "color": "sample string 6"
}

application/xml, text/xml

Sample:

<UpdateContentBlockImagesRequestUI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.Requests">
  <Color>sample string 6</Color>
  <ContentBlockId>1</ContentBlockId>
  <LayoutZone>sample string 5</LayoutZone>
  <Order>4</Order>
  <Title>sample string 3</Title>
  <Type>sample string 2</Type>
  <DeletedImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DeletedImageIds>
  <NewImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels.Requests">
    <d2p1:ImageItem>
      <d2p1:AltText>sample string 1</d2p1:AltText>
      <d2p1:Caption>sample string 2</d2p1:Caption>
      <d2p1:ImageFile>
        <d2p1:FileRepoId>11cd6a0f-ddac-4452-884c-1be302d4f0b3</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:ImageFile>
      <d2p1:LargeImageFile>
        <d2p1:FileRepoId>51638dc6-8d9a-420d-ac9a-1ffe2fc97549</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:LargeImageFile>
      <d2p1:MediumImageFile>
        <d2p1:FileRepoId>21aed93f-b8cd-43ee-a18a-c5a73c24b996</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:MediumImageFile>
      <d2p1:SmallImageFile>
        <d2p1:FileRepoId>93ffb001-7b1f-46e4-9c58-1e67e4d2c14b</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:SmallImageFile>
    </d2p1:ImageItem>
    <d2p1:ImageItem>
      <d2p1:AltText>sample string 1</d2p1:AltText>
      <d2p1:Caption>sample string 2</d2p1:Caption>
      <d2p1:ImageFile>
        <d2p1:FileRepoId>0e43ce62-18e5-478a-b2ce-caebe72f6fba</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:ImageFile>
      <d2p1:LargeImageFile>
        <d2p1:FileRepoId>9d3f7793-b9b4-400c-a85b-c83c2fa09d7a</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:LargeImageFile>
      <d2p1:MediumImageFile>
        <d2p1:FileRepoId>514e1b1a-ef28-439d-924e-a4acbadfa01f</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:MediumImageFile>
      <d2p1:SmallImageFile>
        <d2p1:FileRepoId>2fce0452-6ecd-4348-a692-c116a7b7457c</d2p1:FileRepoId>
        <d2p1:MimeType>sample string 4</d2p1:MimeType>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
      </d2p1:SmallImageFile>
    </d2p1:ImageItem>
  </NewImages>
  <UpdatedImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Page.PageApiModels">
    <d2p1:ImageMetaData>
      <d2p1:AltText>sample string 2</d2p1:AltText>
      <d2p1:Caption>sample string 3</d2p1:Caption>
      <d2p1:ImageId>1</d2p1:ImageId>
    </d2p1:ImageMetaData>
    <d2p1:ImageMetaData>
      <d2p1:AltText>sample string 2</d2p1:AltText>
      <d2p1:Caption>sample string 3</d2p1:Caption>
      <d2p1:ImageId>1</d2p1:ImageId>
    </d2p1:ImageMetaData>
  </UpdatedImages>
</UpdateContentBlockImagesRequestUI>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

Updated image content block.

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.