GET api/v2.0/Announcements/GetAnnouncements?announcementTypeFilter={announcementTypeFilter}&communityKey={communityKey}&micrositeGroupTypeRouteDesignKey={micrositeGroupTypeRouteDesignKey}&sortOrder={sortOrder}&maxResults={maxResults}&includeAnnouncementsWithNoType={includeAnnouncementsWithNoType}

Returns a list of Announcements given the specified criteria.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
announcementTypeFilter

Comma-separated list of AnnouncementTypes to return. Optional: Returns all if none specified.

string

Default value is

communityKey

Filters results by a specific CommunityKey Guid. Optional: Returns all if none specified.

string

Default value is

micrositeGroupTypeRouteDesignKey

Filters results by a specific micrositeGroupTypeRouteDesignKey. Optional: Returns all if none specified.

string

Default value is

sortOrder

Specify SQL-style sort order in a comma-separated string. Optional: Defaults to CreatedOn Date, in descending order if none specified.

string

Default value is

maxResults

The maximum results to return. Optional: Defaults to 100 if not specified.

integer

Default value is 100

includeAnnouncementsWithNoType

If Set to true; returns announcements with no AnnouncementType set. If set to false; returns only announcements specified in the 'announcementTypeFilter' parameter.

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

List of Announcements.

Collection of Announcement
NameDescriptionTypeAdditional information
AnnouncementKey

globally unique identifier

None.

AnnouncementText

string

None.

AnnouncementTitle

string

None.

AnnouncementType

string

None.

CommunityKey

globally unique identifier

None.

CreatedByContactKey

globally unique identifier

None.

ContactDisplayName

string

None.

LinkToContactProfile

string

None.

ContactLargePictureUrl

string

None.

ContactSmallPictureUrl

string

None.

CreatedOn

date

None.

IsLoggingEnabled

boolean

None.

LinkText

string

None.

LinkUrl

string

None.

MicrositeGroupTypeRouteDesignKey

globally unique identifier

None.

OpenNewWindow

boolean

None.

UpdatedByContactKey

globally unique identifier

None.

UpdatedOn

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AnnouncementKey": "442ed7aa-6114-4f2e-b9fa-8c2eb63e275d",
    "AnnouncementText": "sample string 2",
    "AnnouncementTitle": "sample string 3",
    "AnnouncementType": "sample string 4",
    "CommunityKey": "343217c7-5d76-4e74-b641-11f714e92860",
    "CreatedByContactKey": "f973c56a-ad8d-424b-aa40-e68071e4e741",
    "ContactDisplayName": "sample string 7",
    "LinkToContactProfile": "sample string 8",
    "ContactLargePictureUrl": "sample string 9",
    "ContactSmallPictureUrl": "sample string 10",
    "CreatedOn": "2019-05-25T19:31:18.3573365Z",
    "IsLoggingEnabled": true,
    "LinkText": "sample string 13",
    "LinkUrl": "sample string 14",
    "MicrositeGroupTypeRouteDesignKey": "b5547e8f-bf53-45fe-ad80-b6b2bc0d0d43",
    "OpenNewWindow": true,
    "UpdatedByContactKey": "03f6e496-f8b1-4384-9362-7a7450627e90",
    "UpdatedOn": "2019-05-25T19:31:18.3573365Z"
  },
  {
    "AnnouncementKey": "442ed7aa-6114-4f2e-b9fa-8c2eb63e275d",
    "AnnouncementText": "sample string 2",
    "AnnouncementTitle": "sample string 3",
    "AnnouncementType": "sample string 4",
    "CommunityKey": "343217c7-5d76-4e74-b641-11f714e92860",
    "CreatedByContactKey": "f973c56a-ad8d-424b-aa40-e68071e4e741",
    "ContactDisplayName": "sample string 7",
    "LinkToContactProfile": "sample string 8",
    "ContactLargePictureUrl": "sample string 9",
    "ContactSmallPictureUrl": "sample string 10",
    "CreatedOn": "2019-05-25T19:31:18.3573365Z",
    "IsLoggingEnabled": true,
    "LinkText": "sample string 13",
    "LinkUrl": "sample string 14",
    "MicrositeGroupTypeRouteDesignKey": "b5547e8f-bf53-45fe-ad80-b6b2bc0d0d43",
    "OpenNewWindow": true,
    "UpdatedByContactKey": "03f6e496-f8b1-4384-9362-7a7450627e90",
    "UpdatedOn": "2019-05-25T19:31:18.3573365Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <Announcement>
    <AnnouncementKey>442ed7aa-6114-4f2e-b9fa-8c2eb63e275d</AnnouncementKey>
    <AnnouncementText>sample string 2</AnnouncementText>
    <AnnouncementTitle>sample string 3</AnnouncementTitle>
    <AnnouncementType>sample string 4</AnnouncementType>
    <CommunityKey>343217c7-5d76-4e74-b641-11f714e92860</CommunityKey>
    <ContactDisplayName>sample string 7</ContactDisplayName>
    <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl>
    <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl>
    <CreatedByContactKey>f973c56a-ad8d-424b-aa40-e68071e4e741</CreatedByContactKey>
    <CreatedOn>2019-05-25T15:31:18.3573365-04:00</CreatedOn>
    <IsLoggingEnabled>true</IsLoggingEnabled>
    <LinkText>sample string 13</LinkText>
    <LinkToContactProfile>sample string 8</LinkToContactProfile>
    <LinkUrl>sample string 14</LinkUrl>
    <MicrositeGroupTypeRouteDesignKey>b5547e8f-bf53-45fe-ad80-b6b2bc0d0d43</MicrositeGroupTypeRouteDesignKey>
    <OpenNewWindow>true</OpenNewWindow>
    <UpdatedByContactKey>03f6e496-f8b1-4384-9362-7a7450627e90</UpdatedByContactKey>
    <UpdatedOn>2019-05-25T15:31:18.3573365-04:00</UpdatedOn>
  </Announcement>
  <Announcement>
    <AnnouncementKey>442ed7aa-6114-4f2e-b9fa-8c2eb63e275d</AnnouncementKey>
    <AnnouncementText>sample string 2</AnnouncementText>
    <AnnouncementTitle>sample string 3</AnnouncementTitle>
    <AnnouncementType>sample string 4</AnnouncementType>
    <CommunityKey>343217c7-5d76-4e74-b641-11f714e92860</CommunityKey>
    <ContactDisplayName>sample string 7</ContactDisplayName>
    <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl>
    <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl>
    <CreatedByContactKey>f973c56a-ad8d-424b-aa40-e68071e4e741</CreatedByContactKey>
    <CreatedOn>2019-05-25T15:31:18.3573365-04:00</CreatedOn>
    <IsLoggingEnabled>true</IsLoggingEnabled>
    <LinkText>sample string 13</LinkText>
    <LinkToContactProfile>sample string 8</LinkToContactProfile>
    <LinkUrl>sample string 14</LinkUrl>
    <MicrositeGroupTypeRouteDesignKey>b5547e8f-bf53-45fe-ad80-b6b2bc0d0d43</MicrositeGroupTypeRouteDesignKey>
    <OpenNewWindow>true</OpenNewWindow>
    <UpdatedByContactKey>03f6e496-f8b1-4384-9362-7a7450627e90</UpdatedByContactKey>
    <UpdatedOn>2019-05-25T15:31:18.3573365-04:00</UpdatedOn>
  </Announcement>
</ArrayOfAnnouncement>