GET api/v3/sitenotice/{id}

Retrieves the details for the specified site notice.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The integer identifier for the desired notice.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Ghostery.Privacy.Common.Objects.Site3.SiteNotice
NameDescriptionTypeAdditional information
Id

integer

None.

Templates

Collection of Ghostery.Privacy.Common.Objects.Site3.SiteNoticeTemplate

None.

Domain

string

Required

IncludeSubdomains

Ghostery.Privacy.Common.Enums.SiteNoticeIncludeDomainType

None.

DivisionId

integer

Required

SiteNoticeThemeId

integer

Required

ConsentToolThemeId

integer

Required

ConsentDisplayTypeId

integer

Required

Countries

Collection of Ghostery.Privacy.Common.Objects.Site3.SiteNoticeCountry

Required

Translations

Collection of Ghostery.Privacy.Common.Objects.Site3.SiteNoticeTranslation

Required

StagingNotice

boolean

None.

DivisionName

string

None.

ThemeName

string

None.

ConsentToolName

string

None.

CountryCount

integer

None.

TranslationCount

integer

None.

CountryNames

string

None.

TranslationNames

string

None.

CreatedBy

string

None.

Created

date

None.

UpdatedBy

string

None.

Updated

date

None.

AutopopEnabled

boolean

None.

TagpopEnabled

boolean

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'templates[0].notices'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'. Path 'templates[0].notices'.