POST api/v3/sitenotice

Saves the given site notice. If the passed in site notice has a non-zero identifier this call will act as an update. A missing or 0 id value will cause a new notice to be inserted. The passed in notice structure will be validated and if there are errors the return status code will be 500 and the return content will be a list of validation issues.

Request Information

URI Parameters

None.

Body Parameters

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.
TagManager

integer

None.
TemplateEnabled

boolean

None.

Request 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'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'Ghostery.Privacy.Common.Objects.Site3.SiteNotice'.

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.
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 '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'.