GET api/v3/sitenotice/admin/consenttool/{id}

Pulls the details for the specified consent tool theme.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The integer id value for the consent tool theme.

integer

Required

Body Parameters

None.

Response Information

Resource Description

ConsentTool
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Desktop

ConsentToolSetting

None.

DesktopAssets

ConsentToolAsset

None.

Mobile

ConsentToolSetting

None.

MobileAssets

ConsentToolAsset

None.

Notices

Collection of SiteNotice3

None.

Styles

string

None.

BackgroundColor

string

None.

FontColor

string

None.

Logo

string

None.

NoticeCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "desktop": {
    "pageStyle": "sample string 1",
    "logoStyle": "sample string 2",
    "titleStyle": "sample string 3",
    "messageStyle": "sample string 4",
    "sectionTitleStyle": "sample string 5",
    "sectionMessageStyle": "sample string 6",
    "categoryTitleStyle": "sample string 7",
    "vendorNameStyle": "sample string 8",
    "vendorDetailsStyle": "sample string 9",
    "saveButtonStyle": "sample string 10",
    "allOutButtonStyle": "sample string 11",
    "cdmBackgroundStyle": "sample string 12",
    "cdmOverlayStyle": "sample string 13",
    "cdmHeaderStyle": "sample string 14",
    "cdmMessageStyle": "sample string 15",
    "cdmFooterStyle": "sample string 16",
    "cdmCloseButtonStyle": "sample string 17"
  },
  "desktopAssets": {
    "logoId": 1,
    "logoUrl": "sample string 2"
  },
  "mobile": {
    "pageStyle": "sample string 1",
    "logoStyle": "sample string 2",
    "titleStyle": "sample string 3",
    "messageStyle": "sample string 4",
    "sectionTitleStyle": "sample string 5",
    "sectionMessageStyle": "sample string 6",
    "categoryTitleStyle": "sample string 7",
    "vendorNameStyle": "sample string 8",
    "vendorDetailsStyle": "sample string 9",
    "saveButtonStyle": "sample string 10",
    "allOutButtonStyle": "sample string 11",
    "cdmBackgroundStyle": "sample string 12",
    "cdmOverlayStyle": "sample string 13",
    "cdmHeaderStyle": "sample string 14",
    "cdmMessageStyle": "sample string 15",
    "cdmFooterStyle": "sample string 16",
    "cdmCloseButtonStyle": "sample string 17"
  },
  "mobileAssets": {
    "logoId": 1,
    "logoUrl": "sample string 2"
  },
  "notices": [
    {
      "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",
              "permalink": "sample string 6"
            },
            {
              "id": 1,
              "vendorId": 2,
              "category": "sample string 3",
              "required": true,
              "name": "sample string 5",
              "permalink": "sample string 6"
            }
          ],
          "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",
          "geonameId": "sample string 26",
          "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",
              "permalink": "sample string 6"
            },
            {
              "id": 1,
              "vendorId": 2,
              "category": "sample string 3",
              "required": true,
              "name": "sample string 5",
              "permalink": "sample string 6"
            }
          ],
          "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",
          "geonameId": "sample string 26",
          "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-08-21T05:52:36.0908881+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-08-21T05:52:36.0908881+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",
              "permalink": "sample string 6"
            },
            {
              "id": 1,
              "vendorId": 2,
              "category": "sample string 3",
              "required": true,
              "name": "sample string 5",
              "permalink": "sample string 6"
            }
          ],
          "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",
          "geonameId": "sample string 26",
          "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",
              "permalink": "sample string 6"
            },
            {
              "id": 1,
              "vendorId": 2,
              "category": "sample string 3",
              "required": true,
              "name": "sample string 5",
              "permalink": "sample string 6"
            }
          ],
          "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",
          "geonameId": "sample string 26",
          "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-08-21T05:52:36.0908881+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-08-21T05:52:36.0908881+00:00"
    }
  ],
  "styles": "",
  "backgroundColor": "sample string 4",
  "fontColor": "sample string 5",
  "logo": "sample string 6",
  "noticeCount": 7
}