POST restapi/personal/courses/bulletins/v1
Create new light bulletin.
Request Information
URI Parameters
None.
Body Parameters
Represents data for a single bulletin item for insert.
Itslearning.RestApi.Entities.Updatable.LightBulletin.LightBulletinAddInputDataV1Name | Description | Type | Additional information |
---|---|---|---|
CourseId |
The course identifier. |
integer |
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:
{ "CourseId": 1, "Text": "sample string 2", "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-25T14:40:37Z", "ActiveToDate": "2025-06-25T14:40:37Z" }
application/xml, text/xml
Sample:
<LightBulletinAddInputDataV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ActiveFromDate>2025-06-25T14:40:37Z</ActiveFromDate> <ActiveToDate>2025-06-25T14:40:37Z</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 2</Text> <CourseId>1</CourseId> </LightBulletinAddInputDataV1>
application/x-www-form-urlencoded
Sample:
No sample available
Response Information
Resource Description
The bulletin identifier.
Itslearning.RestApi.Entities.LightBulletins.LightBulletinIdentifierName | Description | Type | Additional information |
---|---|---|---|
LightBulletinId |
The light bulletin identifier |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "LightBulletinId": 1 }
application/xml, text/xml
Sample:
<LightBulletinIdentifier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.LightBulletins"> <LightBulletinId>1</LightBulletinId> </LightBulletinIdentifier>