GET restapi/personal/courses/bulletins/{bulletinId}/v1

Gets light bulletin by identifier.

Request Information

URI Parameters

Name	Description	Type	Additional information
bulletinId	The light bulletin identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Light bulletin

Itslearning.RestApi.Entities.LightBulletins.LightBulletinV2

Name	Description	Type	Additional information
LightBulletinId	The unique id for for the light bulletin, in scope of a site (itslearning customer).	integer	None.
Text	Descriptive text for the light bulletin. It's intended to be a plain text, so should be encoded.	string	None.
EmbedUrl	A link to 3rd party content, which can be embedded or inserted as OGP.	string	None.
Pinned	Defines whether current announcement is pinned.	boolean	None.
AllowComments	Defines whether comments creation is allowed for current light bulletin. If there are some comments already, they can still be seen.	boolean	None.
HasResources	DEPRECATED Use ResourcesCount instead. Defines whether any resources were attached to the bulletin.	boolean	None.
AttachedImages	The list of images attached to the light bulletin.	Collection of Itslearning.RestApi.Entities.LightBulletins.LightBulletinImage	None.
ResourcesCount	The count of resources attached to the light bulletin.	integer	None.
CommentsCount	The count of comments for the light bulletin.	integer	None.
ActiveFromDate	The time when to show the bulletin.	date	None.
ActiveToDate	The time when to remove the bulletin.	date	None.
IsSubscribed	Defines if person is subscribed on light bulletin notifications.	boolean	None.
PublishedDate	The time when the bulletin was created.	date	None.
PublishedBy	The person who created the light bulletin.	Itslearning.RestApi.Entities.PersonSimple	None.

Response Formats

application/json, text/json

Sample:

{
  "LightBulletinId": 1,
  "Text": "sample string 2",
  "EmbedUrl": "sample string 3",
  "Pinned": true,
  "AllowComments": true,
  "HasResources": true,
  "AttachedImages": [
    {
      "PreviewFileId": 1,
      "PreviewFileUrl": "sample string 2",
      "OriginalFileId": 3,
      "OriginalFileUrl": "sample string 4"
    },
    {
      "PreviewFileId": 1,
      "PreviewFileUrl": "sample string 2",
      "OriginalFileId": 3,
      "OriginalFileUrl": "sample string 4"
    }
  ],
  "ResourcesCount": 7,
  "CommentsCount": 8,
  "ActiveFromDate": "2025-06-18T13:54:23Z",
  "ActiveToDate": "2025-06-18T13:54:23Z",
  "IsSubscribed": true,
  "PublishedDate": "2025-06-18T13:54:23Z",
  "PublishedBy": {
    "PersonId": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "FullName": "sample string 4",
    "ProfileUrl": "sample string 5",
    "AdditionalInfo": "sample string 6",
    "ProfileImageUrl": "sample string 7",
    "ProfileImageUrlSmall": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<LightBulletinV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ActiveFromDate>2025-06-18T13:54:23Z</ActiveFromDate>
  <ActiveToDate>2025-06-18T13:54:23Z</ActiveToDate>
  <AllowComments>true</AllowComments>
  <AttachedImages>
    <LightBulletinImage>
      <OriginalFileId>3</OriginalFileId>
      <OriginalFileUrl>sample string 4</OriginalFileUrl>
      <PreviewFileId>1</PreviewFileId>
      <PreviewFileUrl>sample string 2</PreviewFileUrl>
    </LightBulletinImage>
    <LightBulletinImage>
      <OriginalFileId>3</OriginalFileId>
      <OriginalFileUrl>sample string 4</OriginalFileUrl>
      <PreviewFileId>1</PreviewFileId>
      <PreviewFileUrl>sample string 2</PreviewFileUrl>
    </LightBulletinImage>
  </AttachedImages>
  <CommentsCount>8</CommentsCount>
  <EmbedUrl>sample string 3</EmbedUrl>
  <HasResources>true</HasResources>
  <IsSubscribed>true</IsSubscribed>
  <LightBulletinId>1</LightBulletinId>
  <Pinned>true</Pinned>
  <PublishedBy>
    <AdditionalInfo>sample string 6</AdditionalInfo>
    <FirstName>sample string 2</FirstName>
    <FullName>sample string 4</FullName>
    <LastName>sample string 3</LastName>
    <PersonId>1</PersonId>
    <ProfileImageUrl>sample string 7</ProfileImageUrl>
    <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
    <ProfileUrl>sample string 5</ProfileUrl>
  </PublishedBy>
  <PublishedDate>2025-06-18T13:54:23Z</PublishedDate>
  <ResourcesCount>7</ResourcesCount>
  <Text>sample string 2</Text>
</LightBulletinV2>