GET api/v2.0/Announcements/GetAnnouncement?announcementKey={announcementKey}

Returns the details of the specified Announcement.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
announcementKey

Unique key of a specific Announcement.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

An Announcement.

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": "af402150-8b4e-4a1d-afe4-464c53ea8d5d",
    "AnnouncementText": "sample string 2",
    "AnnouncementTitle": "sample string 3",
    "AnnouncementType": "sample string 4",
    "CommunityKey": "06bd9341-4654-4718-8274-3160fd8dafff",
    "CreatedByContactKey": "c0bae7b3-f247-491e-af43-d97c8b3ad117",
    "ContactDisplayName": "sample string 7",
    "LinkToContactProfile": "sample string 8",
    "ContactLargePictureUrl": "sample string 9",
    "ContactSmallPictureUrl": "sample string 10",
    "CreatedOn": "2019-07-21T08:25:10.5221156Z",
    "IsLoggingEnabled": true,
    "LinkText": "sample string 13",
    "LinkUrl": "sample string 14",
    "MicrositeGroupTypeRouteDesignKey": "192311ac-2bce-4147-a2c6-6b25b4524414",
    "OpenNewWindow": true,
    "UpdatedByContactKey": "911634c9-361d-45e8-8588-a62b3aaad367",
    "UpdatedOn": "2019-07-21T08:25:10.5221156Z"
  },
  {
    "AnnouncementKey": "af402150-8b4e-4a1d-afe4-464c53ea8d5d",
    "AnnouncementText": "sample string 2",
    "AnnouncementTitle": "sample string 3",
    "AnnouncementType": "sample string 4",
    "CommunityKey": "06bd9341-4654-4718-8274-3160fd8dafff",
    "CreatedByContactKey": "c0bae7b3-f247-491e-af43-d97c8b3ad117",
    "ContactDisplayName": "sample string 7",
    "LinkToContactProfile": "sample string 8",
    "ContactLargePictureUrl": "sample string 9",
    "ContactSmallPictureUrl": "sample string 10",
    "CreatedOn": "2019-07-21T08:25:10.5221156Z",
    "IsLoggingEnabled": true,
    "LinkText": "sample string 13",
    "LinkUrl": "sample string 14",
    "MicrositeGroupTypeRouteDesignKey": "192311ac-2bce-4147-a2c6-6b25b4524414",
    "OpenNewWindow": true,
    "UpdatedByContactKey": "911634c9-361d-45e8-8588-a62b3aaad367",
    "UpdatedOn": "2019-07-21T08:25:10.5221156Z"
  }
]

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>af402150-8b4e-4a1d-afe4-464c53ea8d5d</AnnouncementKey>
    <AnnouncementText>sample string 2</AnnouncementText>
    <AnnouncementTitle>sample string 3</AnnouncementTitle>
    <AnnouncementType>sample string 4</AnnouncementType>
    <CommunityKey>06bd9341-4654-4718-8274-3160fd8dafff</CommunityKey>
    <ContactDisplayName>sample string 7</ContactDisplayName>
    <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl>
    <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl>
    <CreatedByContactKey>c0bae7b3-f247-491e-af43-d97c8b3ad117</CreatedByContactKey>
    <CreatedOn>2019-07-21T04:25:10.5221156-04:00</CreatedOn>
    <IsLoggingEnabled>true</IsLoggingEnabled>
    <LinkText>sample string 13</LinkText>
    <LinkToContactProfile>sample string 8</LinkToContactProfile>
    <LinkUrl>sample string 14</LinkUrl>
    <MicrositeGroupTypeRouteDesignKey>192311ac-2bce-4147-a2c6-6b25b4524414</MicrositeGroupTypeRouteDesignKey>
    <OpenNewWindow>true</OpenNewWindow>
    <UpdatedByContactKey>911634c9-361d-45e8-8588-a62b3aaad367</UpdatedByContactKey>
    <UpdatedOn>2019-07-21T04:25:10.5221156-04:00</UpdatedOn>
  </Announcement>
  <Announcement>
    <AnnouncementKey>af402150-8b4e-4a1d-afe4-464c53ea8d5d</AnnouncementKey>
    <AnnouncementText>sample string 2</AnnouncementText>
    <AnnouncementTitle>sample string 3</AnnouncementTitle>
    <AnnouncementType>sample string 4</AnnouncementType>
    <CommunityKey>06bd9341-4654-4718-8274-3160fd8dafff</CommunityKey>
    <ContactDisplayName>sample string 7</ContactDisplayName>
    <ContactLargePictureUrl>sample string 9</ContactLargePictureUrl>
    <ContactSmallPictureUrl>sample string 10</ContactSmallPictureUrl>
    <CreatedByContactKey>c0bae7b3-f247-491e-af43-d97c8b3ad117</CreatedByContactKey>
    <CreatedOn>2019-07-21T04:25:10.5221156-04:00</CreatedOn>
    <IsLoggingEnabled>true</IsLoggingEnabled>
    <LinkText>sample string 13</LinkText>
    <LinkToContactProfile>sample string 8</LinkToContactProfile>
    <LinkUrl>sample string 14</LinkUrl>
    <MicrositeGroupTypeRouteDesignKey>192311ac-2bce-4147-a2c6-6b25b4524414</MicrositeGroupTypeRouteDesignKey>
    <OpenNewWindow>true</OpenNewWindow>
    <UpdatedByContactKey>911634c9-361d-45e8-8588-a62b3aaad367</UpdatedByContactKey>
    <UpdatedOn>2019-07-21T04:25:10.5221156-04:00</UpdatedOn>
  </Announcement>
</ArrayOfAnnouncement>