Api Home > Announcement > GetUserAnnouncements

GET api/V3/Announcement/GetUserAnnouncements?userId={userId}&languageCode={languageCode} Get all announcements by user and language.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

The user Id

globally unique identifier

Required

languageCode

The 3-letter language code

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Announcement
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Title

string

None.

Priority

string

None.

PriorityId

globally unique identifier

None.

Body

string

None.

AccessGroupId

globally unique identifier

None.

StartDate

date

None.

EndDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "563da9ab-fe15-422a-b4cf-0f2e5d28c3d3",
    "Title": "sample string 2",
    "Priority": "sample string 3",
    "PriorityId": "63e7eb38-94a8-4897-b3fc-67701de59803",
    "Body": "sample string 5",
    "AccessGroupId": "07d2c730-d9f4-4d29-858b-2fd4acbc5899",
    "StartDate": "2024-03-29T11:42:03.704Z",
    "EndDate": "2024-03-29T11:42:03.704Z"
  },
  {
    "Id": "563da9ab-fe15-422a-b4cf-0f2e5d28c3d3",
    "Title": "sample string 2",
    "Priority": "sample string 3",
    "PriorityId": "63e7eb38-94a8-4897-b3fc-67701de59803",
    "Body": "sample string 5",
    "AccessGroupId": "07d2c730-d9f4-4d29-858b-2fd4acbc5899",
    "StartDate": "2024-03-29T11:42:03.704Z",
    "EndDate": "2024-03-29T11:42:03.704Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <Announcement>
    <AccessGroupId>07d2c730-d9f4-4d29-858b-2fd4acbc5899</AccessGroupId>
    <Body>sample string 5</Body>
    <EndDate>2024-03-29T11:42:03.7044383+00:00</EndDate>
    <Id>563da9ab-fe15-422a-b4cf-0f2e5d28c3d3</Id>
    <Priority>sample string 3</Priority>
    <PriorityId>63e7eb38-94a8-4897-b3fc-67701de59803</PriorityId>
    <StartDate>2024-03-29T11:42:03.7044383+00:00</StartDate>
    <Title>sample string 2</Title>
  </Announcement>
  <Announcement>
    <AccessGroupId>07d2c730-d9f4-4d29-858b-2fd4acbc5899</AccessGroupId>
    <Body>sample string 5</Body>
    <EndDate>2024-03-29T11:42:03.7044383+00:00</EndDate>
    <Id>563da9ab-fe15-422a-b4cf-0f2e5d28c3d3</Id>
    <Priority>sample string 3</Priority>
    <PriorityId>63e7eb38-94a8-4897-b3fc-67701de59803</PriorityId>
    <StartDate>2024-03-29T11:42:03.7044383+00:00</StartDate>
    <Title>sample string 2</Title>
  </Announcement>
</ArrayOfAnnouncement>