GET api/v2.0/Announcements/GetAnnouncements?announcementTypeFilter={announcementTypeFilter}&communityKey={communityKey}µsiteGroupTypeRouteDesignKey={micrositeGroupTypeRouteDesignKey}&sortOrder={sortOrder}&maxResults={maxResults}&includeAnnouncementsWithNoType={includeAnnouncementsWithNoType}
Returns a list of Announcements given the specified criteria.
Request Information
URI Parameters
Name | Description | Type | Additional 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 AnnouncementName | Description | Type | Additional information |
---|---|---|---|
AnnouncementKey |
The primary key for the announcement. |
globally unique identifier |
None. |
AnnouncementText |
The announcement content/body. |
string |
None. |
AnnouncementTitle |
Title of the announcement. |
string |
None. |
AnnouncementType |
Type of announcement, otherwise string.Empty. |
string |
None. |
CommunityKey |
If the announcement is associated to a community, is the primary key for the community, otherwise Guid.Empty. |
globally unique identifier |
None. |
CommunityName |
If the announcement is associated to a community, is the name of the community, otherwise not included. |
string |
None. |
CreatedByContactKey |
The primary key of the contact who created the announcement. |
globally unique identifier |
None. |
ContactDisplayName |
The display name of the contact who created the announcement. |
string |
None. |
LinkToContactProfile |
The url that links to the profile of the contact who created the announcement. |
string |
None. |
ContactLargePictureUrl |
The url of the large picture of the contact who created the announcement. |
string |
None. |
ContactSmallPictureUrl |
The url of the small picture of the contact who created the announcement. |
string |
None. |
CreatedOn |
The DateTime at which the announcement was created. |
date |
None. |
IsLoggingEnabled |
If logging is enabled for this item. |
boolean |
None. |
LinkText |
URL Text given at creation the text to be displayed with the LinkUrl. Optional, else is string.Empty. |
string |
None. |
LinkUrl |
Additional URL given at creation. Optional, else is string.Empty. |
string |
None. |
MicrositeGroupTypeRouteDesignKey |
The primary key for the MicrositeGroupTypeRouteDesign for the announcement. |
globally unique identifier |
None. |
OpenNewWindow |
If the LinkUrl should open in a new window. |
boolean |
None. |
Tags |
All of the tags indexed for the item. This includes user tags and admin based tags. |
Collection of ItemTagResponse |
None. |
UpdatedByContactKey |
The primary key of the contact who last updated the announcement. |
globally unique identifier |
None. |
UpdatedOn |
The DateTime at which the announcement was last updated. |
date |
None. |
UserPermissions |
Permissions for actions the current user can take |
Collection of string |
None. |
Response Formats
application/json, text/json
[ { "AnnouncementKey": "28547c51-f827-4ea6-b5f9-d5fcdd248253", "AnnouncementText": "sample string 2", "AnnouncementTitle": "sample string 3", "AnnouncementType": "sample string 4", "CommunityKey": "f80359c5-1974-42a7-b218-229a2de2bbf6", "CommunityName": "sample string 6", "CreatedByContactKey": "17a797df-76fa-4dbf-a1bc-c7c9b996ed2b", "ContactDisplayName": "sample string 8", "LinkToContactProfile": "sample string 9", "ContactLargePictureUrl": "sample string 10", "ContactSmallPictureUrl": "sample string 11", "CreatedOn": "2024-07-27T12:56:06.1988871Z", "IsLoggingEnabled": true, "LinkText": "sample string 14", "LinkUrl": "sample string 15", "MicrositeGroupTypeRouteDesignKey": "136a8476-c6c7-4335-85b0-524b9388e4f2", "OpenNewWindow": true, "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "UpdatedByContactKey": "da5c3fda-68fa-4eb6-9309-4e383346ecb5", "UpdatedOn": "2024-07-27T12:56:06.1988871Z", "UserPermissions": [ "sample string 1", "sample string 2" ] }, { "AnnouncementKey": "28547c51-f827-4ea6-b5f9-d5fcdd248253", "AnnouncementText": "sample string 2", "AnnouncementTitle": "sample string 3", "AnnouncementType": "sample string 4", "CommunityKey": "f80359c5-1974-42a7-b218-229a2de2bbf6", "CommunityName": "sample string 6", "CreatedByContactKey": "17a797df-76fa-4dbf-a1bc-c7c9b996ed2b", "ContactDisplayName": "sample string 8", "LinkToContactProfile": "sample string 9", "ContactLargePictureUrl": "sample string 10", "ContactSmallPictureUrl": "sample string 11", "CreatedOn": "2024-07-27T12:56:06.1988871Z", "IsLoggingEnabled": true, "LinkText": "sample string 14", "LinkUrl": "sample string 15", "MicrositeGroupTypeRouteDesignKey": "136a8476-c6c7-4335-85b0-524b9388e4f2", "OpenNewWindow": true, "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "UpdatedByContactKey": "da5c3fda-68fa-4eb6-9309-4e383346ecb5", "UpdatedOn": "2024-07-27T12:56:06.1988871Z", "UserPermissions": [ "sample string 1", "sample string 2" ] } ]
application/xml, text/xml
<ArrayOfAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise"> <Announcement> <AnnouncementKey>28547c51-f827-4ea6-b5f9-d5fcdd248253</AnnouncementKey> <AnnouncementText>sample string 2</AnnouncementText> <AnnouncementTitle>sample string 3</AnnouncementTitle> <AnnouncementType>sample string 4</AnnouncementType> <CommunityKey>f80359c5-1974-42a7-b218-229a2de2bbf6</CommunityKey> <CommunityName>sample string 6</CommunityName> <ContactDisplayName>sample string 8</ContactDisplayName> <ContactLargePictureUrl>sample string 10</ContactLargePictureUrl> <ContactSmallPictureUrl>sample string 11</ContactSmallPictureUrl> <CreatedByContactKey>17a797df-76fa-4dbf-a1bc-c7c9b996ed2b</CreatedByContactKey> <CreatedOn>2024-07-27T08:56:06.1988871-04:00</CreatedOn> <IsLoggingEnabled>true</IsLoggingEnabled> <LinkText>sample string 14</LinkText> <LinkToContactProfile>sample string 9</LinkToContactProfile> <LinkUrl>sample string 15</LinkUrl> <MicrositeGroupTypeRouteDesignKey>136a8476-c6c7-4335-85b0-524b9388e4f2</MicrositeGroupTypeRouteDesignKey> <OpenNewWindow>true</OpenNewWindow> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <UpdatedByContactKey>da5c3fda-68fa-4eb6-9309-4e383346ecb5</UpdatedByContactKey> <UpdatedOn>2024-07-27T08:56:06.1988871-04:00</UpdatedOn> <UserPermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </UserPermissions> </Announcement> <Announcement> <AnnouncementKey>28547c51-f827-4ea6-b5f9-d5fcdd248253</AnnouncementKey> <AnnouncementText>sample string 2</AnnouncementText> <AnnouncementTitle>sample string 3</AnnouncementTitle> <AnnouncementType>sample string 4</AnnouncementType> <CommunityKey>f80359c5-1974-42a7-b218-229a2de2bbf6</CommunityKey> <CommunityName>sample string 6</CommunityName> <ContactDisplayName>sample string 8</ContactDisplayName> <ContactLargePictureUrl>sample string 10</ContactLargePictureUrl> <ContactSmallPictureUrl>sample string 11</ContactSmallPictureUrl> <CreatedByContactKey>17a797df-76fa-4dbf-a1bc-c7c9b996ed2b</CreatedByContactKey> <CreatedOn>2024-07-27T08:56:06.1988871-04:00</CreatedOn> <IsLoggingEnabled>true</IsLoggingEnabled> <LinkText>sample string 14</LinkText> <LinkToContactProfile>sample string 9</LinkToContactProfile> <LinkUrl>sample string 15</LinkUrl> <MicrositeGroupTypeRouteDesignKey>136a8476-c6c7-4335-85b0-524b9388e4f2</MicrositeGroupTypeRouteDesignKey> <OpenNewWindow>true</OpenNewWindow> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <UpdatedByContactKey>da5c3fda-68fa-4eb6-9309-4e383346ecb5</UpdatedByContactKey> <UpdatedOn>2024-07-27T08:56:06.1988871-04:00</UpdatedOn> <UserPermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </UserPermissions> </Announcement> </ArrayOfAnnouncement>