PUT restapi/personal/courses/bulletins/v1
Updates the light bulletin
Request Information
URI Parameters
None.
Body Parameters
Represents data for a single bulletin item for update
Itslearning.RestApi.Entities.Updatable.LightBulletin.LightBulletinUpdateInputDataV1Name | Description | Type | Additional information |
---|---|---|---|
LightBulletinId |
The unique id for for the light bulletin, in scope of a site (itslearning customer). |
integer |
None. |
ElementIdsToDetach |
The collection of elements to detach. |
Collection of integer |
None. |
DeleteAttachedImage |
The deletion flag of attached image. |
boolean |
None. |
Text |
The descriptive text for the light bulletin. It's intended to be a plain text, so should be encoded. |
string |
None. |
ElementIdsToAttach |
The collection of elements to attach. |
Collection of integer |
None. |
AttachedImages |
The collection of attached images. |
Collection of Itslearning.RestApi.Entities.Updatable.LightBulletin.LightBulletinInputImageDataV1 |
None. |
AllowComments |
Defines whether comments creation is allowed for current light bulletin. |
boolean |
None. |
ActiveFromDate |
The time when to show the bulletin. |
date |
None. |
ActiveToDate |
The time when to remove the bulletin. |
date |
None. |
Request Formats
application/json, text/json
Sample:
{ "LightBulletinId": 1, "ElementIdsToDetach": [ 1, 2 ], "DeleteAttachedImage": true, "Text": "sample string 3", "ElementIdsToAttach": [ 1, 2 ], "AttachedImages": [ { "PreviewFile": { "FileId": "sample string 1", "Signature": "sample string 2", "FileName": "sample string 3" }, "OriginalFile": { "FileId": "sample string 1", "Signature": "sample string 2", "FileName": "sample string 3" } }, { "PreviewFile": { "FileId": "sample string 1", "Signature": "sample string 2", "FileName": "sample string 3" }, "OriginalFile": { "FileId": "sample string 1", "Signature": "sample string 2", "FileName": "sample string 3" } } ], "AllowComments": true, "ActiveFromDate": "2025-06-17T10:04:54Z", "ActiveToDate": "2025-06-17T10:04:54Z" }
application/xml, text/xml
Sample:
<LightBulletinUpdateInputDataV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ActiveFromDate>2025-06-17T10:04:54Z</ActiveFromDate> <ActiveToDate>2025-06-17T10:04:54Z</ActiveToDate> <AllowComments>true</AllowComments> <AttachedImages> <LightBulletinInputImageDataV1> <OriginalFile> <FileId>sample string 1</FileId> <FileName>sample string 3</FileName> <Signature>sample string 2</Signature> </OriginalFile> <PreviewFile> <FileId>sample string 1</FileId> <FileName>sample string 3</FileName> <Signature>sample string 2</Signature> </PreviewFile> </LightBulletinInputImageDataV1> <LightBulletinInputImageDataV1> <OriginalFile> <FileId>sample string 1</FileId> <FileName>sample string 3</FileName> <Signature>sample string 2</Signature> </OriginalFile> <PreviewFile> <FileId>sample string 1</FileId> <FileName>sample string 3</FileName> <Signature>sample string 2</Signature> </PreviewFile> </LightBulletinInputImageDataV1> </AttachedImages> <ElementIdsToAttach xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </ElementIdsToAttach> <Text>sample string 3</Text> <DeleteAttachedImage>true</DeleteAttachedImage> <ElementIdsToDetach xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </ElementIdsToDetach> <LightBulletinId>1</LightBulletinId> </LightBulletinUpdateInputDataV1>
application/x-www-form-urlencoded
Sample:
No sample available
Response Information
Resource Description
Light bulletin id
System.Net.Http.HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | System.Version |
None. |
|
Content | System.Net.Http.HttpContent |
None. |
|
StatusCode | System.Net.HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | System.Net.Http.HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |