GET api/v3/sitenotice?domain={domain}

Default call used to get all the users domains. We also have the option to pass in a query string with the domain parameter. This will instruct this call to only pull notices for that domain. This is primarily used when modifying a notice to keep us from adding duplicate countries to multiple notices for the same domain since domain/country pair must be unique.

Request Information

URI Parameters

Name	Description	Type	Additional information
domain	The domain query parameter is only used for duplicate domain checks and should not be used when pulling a list of site notices for consumption.	string	None.

Body Parameters

None.

Response Information

Resource Description

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

Name	Type	Additional 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.
TagManager	integer	None.
TemplateEnabled	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 '[0].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 '[0].templates[0].notices'.