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 | 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
[ { "AnnouncementKey": "23dd46d0-6a07-4d7a-b4c4-1e78369a7ed2", "AnnouncementText": "sample string 2", "AnnouncementTitle": "sample string 3", "AnnouncementType": "sample string 4", "CommunityKey": "97b59085-43ec-4298-bd87-f3cda9c1ccc5", "CreatedByContactKey": "d1c188f9-f2ef-4baf-9980-f20bf5141dd2", "ContactDisplayName": "sample string 7", "LinkToContactProfile": "sample string 8", "ContactLargePictureUrl": "sample string 9", "ContactSmallPictureUrl": "sample string 10", "CreatedOn": "2021-01-19T14:45:49.5039486Z", "IsLoggingEnabled": true, "LinkText": "sample string 13", "LinkUrl": "sample string 14", "MicrositeGroupTypeRouteDesignKey": "38c92178-555e-44d2-b615-c3aed44941e9", "OpenNewWindow": true, "UpdatedByContactKey": "67a0e1fb-ceaa-416c-aa44-473122b63ad4", "UpdatedOn": "2021-01-19T14:45:49.5039486Z" }, { "AnnouncementKey": "23dd46d0-6a07-4d7a-b4c4-1e78369a7ed2", "AnnouncementText": "sample string 2", "AnnouncementTitle": "sample string 3", "AnnouncementType": "sample string 4", "CommunityKey": "97b59085-43ec-4298-bd87-f3cda9c1ccc5", "CreatedByContactKey": "d1c188f9-f2ef-4baf-9980-f20bf5141dd2", "ContactDisplayName": "sample string 7", "LinkToContactProfile": "sample string 8", "ContactLargePictureUrl": "sample string 9", "ContactSmallPictureUrl": "sample string 10", "CreatedOn": "2021-01-19T14:45:49.5039486Z", "IsLoggingEnabled": true, "LinkText": "sample string 13", "LinkUrl": "sample string 14", "MicrositeGroupTypeRouteDesignKey": "38c92178-555e-44d2-b615-c3aed44941e9", "OpenNewWindow": true, "UpdatedByContactKey": "67a0e1fb-ceaa-416c-aa44-473122b63ad4", "UpdatedOn": "2021-01-19T14:45:49.5039486Z" } ]
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>23dd46d0-6a07-4d7a-b4c4-1e78369a7ed2</AnnouncementKey> <AnnouncementText>sample string 2</AnnouncementText> <AnnouncementTitle>sample string 3</AnnouncementTitle> <AnnouncementType>sample string 4</AnnouncementType> <CommunityKey>97b59085-43ec-4298-bd87-f3cda9c1ccc5</CommunityKey> <ContactDisplayName>sample string 7</ContactDisplayName> <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl> <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl> <CreatedByContactKey>d1c188f9-f2ef-4baf-9980-f20bf5141dd2</CreatedByContactKey> <CreatedOn>2021-01-19T09:45:49.5039486-05:00</CreatedOn> <IsLoggingEnabled>true</IsLoggingEnabled> <LinkText>sample string 13</LinkText> <LinkToContactProfile>sample string 8</LinkToContactProfile> <LinkUrl>sample string 14</LinkUrl> <MicrositeGroupTypeRouteDesignKey>38c92178-555e-44d2-b615-c3aed44941e9</MicrositeGroupTypeRouteDesignKey> <OpenNewWindow>true</OpenNewWindow> <UpdatedByContactKey>67a0e1fb-ceaa-416c-aa44-473122b63ad4</UpdatedByContactKey> <UpdatedOn>2021-01-19T09:45:49.5039486-05:00</UpdatedOn> </Announcement> <Announcement> <AnnouncementKey>23dd46d0-6a07-4d7a-b4c4-1e78369a7ed2</AnnouncementKey> <AnnouncementText>sample string 2</AnnouncementText> <AnnouncementTitle>sample string 3</AnnouncementTitle> <AnnouncementType>sample string 4</AnnouncementType> <CommunityKey>97b59085-43ec-4298-bd87-f3cda9c1ccc5</CommunityKey> <ContactDisplayName>sample string 7</ContactDisplayName> <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl> <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl> <CreatedByContactKey>d1c188f9-f2ef-4baf-9980-f20bf5141dd2</CreatedByContactKey> <CreatedOn>2021-01-19T09:45:49.5039486-05:00</CreatedOn> <IsLoggingEnabled>true</IsLoggingEnabled> <LinkText>sample string 13</LinkText> <LinkToContactProfile>sample string 8</LinkToContactProfile> <LinkUrl>sample string 14</LinkUrl> <MicrositeGroupTypeRouteDesignKey>38c92178-555e-44d2-b615-c3aed44941e9</MicrositeGroupTypeRouteDesignKey> <OpenNewWindow>true</OpenNewWindow> <UpdatedByContactKey>67a0e1fb-ceaa-416c-aa44-473122b63ad4</UpdatedByContactKey> <UpdatedOn>2021-01-19T09:45:49.5039486-05:00</UpdatedOn> </Announcement> </ArrayOfAnnouncement>