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

NameDescriptionTypeAdditional 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 SiteNotice3
NameDescriptionTypeAdditional information
Id

integer

None.

Domain

string

Required

IncludeSubdomains

SiteNoticeIncludeDomainType

None.

DivisionId

integer

Required

SiteNoticeThemeId

integer

Required

ConsentToolThemeId

integer

Required

ConsentDisplayTypeId

integer

Required

Countries

Collection of SiteNoticeCountry

Required

Translations

Collection of 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.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "domain": "sample string 2",
    "includeSubdomains": 0,
    "divisionId": 3,
    "siteNoticeThemeId": 4,
    "consentToolThemeId": 5,
    "consentDisplayTypeId": 6,
    "countries": [
      {
        "id": 1,
        "countryId": 2,
        "consentTypeId": 3,
        "privacyAccessTypeId": 4,
        "default": true,
        "defaultTranslationId": 6,
        "consentRequired": true,
        "consentDurationMonths": 1,
        "closeConsentEnabled": true,
        "scrollConsentEnabled": true,
        "pageclickConsentEnabled": true,
        "navigateConsentEnabled": true,
        "l2Enabled": true,
        "iabEnabled": true,
        "pubvendorsLink": "sample string 14",
        "gdprEnabled": true,
        "dataRightsType": 0,
        "dataRightsLink": "sample string 16",
        "dataRightsFormEmail": "sample string 17",
        "autoPopEnabled": true,
        "autoPopThreshold": 19,
        "scanGroupId": 20,
        "privacyPolicyLink": "sample string 21",
        "consentDetailCategories": true,
        "consentDetailVendors": true,
        "adChoicesEnabled": true,
        "countryVendorIds": [
          1,
          2
        ],
        "vendors": [
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          },
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          }
        ],
        "cookies": [
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          },
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          }
        ],
        "scanCountryId": 1,
        "name": "sample string 25",
        "vendorLinks": {
          "1": "sample string 2",
          "3": "sample string 4"
        }
      },
      {
        "id": 1,
        "countryId": 2,
        "consentTypeId": 3,
        "privacyAccessTypeId": 4,
        "default": true,
        "defaultTranslationId": 6,
        "consentRequired": true,
        "consentDurationMonths": 1,
        "closeConsentEnabled": true,
        "scrollConsentEnabled": true,
        "pageclickConsentEnabled": true,
        "navigateConsentEnabled": true,
        "l2Enabled": true,
        "iabEnabled": true,
        "pubvendorsLink": "sample string 14",
        "gdprEnabled": true,
        "dataRightsType": 0,
        "dataRightsLink": "sample string 16",
        "dataRightsFormEmail": "sample string 17",
        "autoPopEnabled": true,
        "autoPopThreshold": 19,
        "scanGroupId": 20,
        "privacyPolicyLink": "sample string 21",
        "consentDetailCategories": true,
        "consentDetailVendors": true,
        "adChoicesEnabled": true,
        "countryVendorIds": [
          1,
          2
        ],
        "vendors": [
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          },
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          }
        ],
        "cookies": [
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          },
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          }
        ],
        "scanCountryId": 1,
        "name": "sample string 25",
        "vendorLinks": {
          "1": "sample string 2",
          "3": "sample string 4"
        }
      }
    ],
    "translations": [
      {
        "id": 1,
        "companyTranslationId": 2,
        "siteNoticeId": 3,
        "languageCode": "sample string 4",
        "default": true,
        "name": "sample string 6",
        "languageId": 7
      },
      {
        "id": 1,
        "companyTranslationId": 2,
        "siteNoticeId": 3,
        "languageCode": "sample string 4",
        "default": true,
        "name": "sample string 6",
        "languageId": 7
      }
    ],
    "stagingNotice": true,
    "divisionName": "sample string 8",
    "themeName": "sample string 9",
    "consentToolName": "sample string 10",
    "countryCount": 11,
    "translationCount": 12,
    "countryNames": "sample string 13",
    "translationNames": "sample string 14",
    "createdBy": "sample string 15",
    "created": "2019-05-24T10:16:54.7357488+00:00",
    "updatedBy": "sample string 17",
    "updated": "2019-05-24T10:16:54.7357488+00:00"
  },
  {
    "id": 1,
    "domain": "sample string 2",
    "includeSubdomains": 0,
    "divisionId": 3,
    "siteNoticeThemeId": 4,
    "consentToolThemeId": 5,
    "consentDisplayTypeId": 6,
    "countries": [
      {
        "id": 1,
        "countryId": 2,
        "consentTypeId": 3,
        "privacyAccessTypeId": 4,
        "default": true,
        "defaultTranslationId": 6,
        "consentRequired": true,
        "consentDurationMonths": 1,
        "closeConsentEnabled": true,
        "scrollConsentEnabled": true,
        "pageclickConsentEnabled": true,
        "navigateConsentEnabled": true,
        "l2Enabled": true,
        "iabEnabled": true,
        "pubvendorsLink": "sample string 14",
        "gdprEnabled": true,
        "dataRightsType": 0,
        "dataRightsLink": "sample string 16",
        "dataRightsFormEmail": "sample string 17",
        "autoPopEnabled": true,
        "autoPopThreshold": 19,
        "scanGroupId": 20,
        "privacyPolicyLink": "sample string 21",
        "consentDetailCategories": true,
        "consentDetailVendors": true,
        "adChoicesEnabled": true,
        "countryVendorIds": [
          1,
          2
        ],
        "vendors": [
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          },
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          }
        ],
        "cookies": [
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          },
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          }
        ],
        "scanCountryId": 1,
        "name": "sample string 25",
        "vendorLinks": {
          "1": "sample string 2",
          "3": "sample string 4"
        }
      },
      {
        "id": 1,
        "countryId": 2,
        "consentTypeId": 3,
        "privacyAccessTypeId": 4,
        "default": true,
        "defaultTranslationId": 6,
        "consentRequired": true,
        "consentDurationMonths": 1,
        "closeConsentEnabled": true,
        "scrollConsentEnabled": true,
        "pageclickConsentEnabled": true,
        "navigateConsentEnabled": true,
        "l2Enabled": true,
        "iabEnabled": true,
        "pubvendorsLink": "sample string 14",
        "gdprEnabled": true,
        "dataRightsType": 0,
        "dataRightsLink": "sample string 16",
        "dataRightsFormEmail": "sample string 17",
        "autoPopEnabled": true,
        "autoPopThreshold": 19,
        "scanGroupId": 20,
        "privacyPolicyLink": "sample string 21",
        "consentDetailCategories": true,
        "consentDetailVendors": true,
        "adChoicesEnabled": true,
        "countryVendorIds": [
          1,
          2
        ],
        "vendors": [
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          },
          {
            "id": 1,
            "vendorId": 2,
            "category": "sample string 3",
            "required": true,
            "name": "sample string 5"
          }
        ],
        "cookies": [
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          },
          {
            "id": 1,
            "siteNoticeCountryId": 2,
            "name": "sample string 3",
            "description": "sample string 4",
            "required": true,
            "optOut": "sample string 6"
          }
        ],
        "scanCountryId": 1,
        "name": "sample string 25",
        "vendorLinks": {
          "1": "sample string 2",
          "3": "sample string 4"
        }
      }
    ],
    "translations": [
      {
        "id": 1,
        "companyTranslationId": 2,
        "siteNoticeId": 3,
        "languageCode": "sample string 4",
        "default": true,
        "name": "sample string 6",
        "languageId": 7
      },
      {
        "id": 1,
        "companyTranslationId": 2,
        "siteNoticeId": 3,
        "languageCode": "sample string 4",
        "default": true,
        "name": "sample string 6",
        "languageId": 7
      }
    ],
    "stagingNotice": true,
    "divisionName": "sample string 8",
    "themeName": "sample string 9",
    "consentToolName": "sample string 10",
    "countryCount": 11,
    "translationCount": 12,
    "countryNames": "sample string 13",
    "translationNames": "sample string 14",
    "createdBy": "sample string 15",
    "created": "2019-05-24T10:16:54.7357488+00:00",
    "updatedBy": "sample string 17",
    "updated": "2019-05-24T10:16:54.7357488+00:00"
  }
]