POST api/v1/company/translation

Saves the passed in Company Translation object. You are not allowed to create a new company translation record using this mechanism, only update an existing set of translation values.

Request Information

URI Parameters

None.

Body Parameters

CompanyTranslation
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

LanguageId

integer

None.

LanguageCode

string

None.

Updated

date

None.

UpdatedBy

string

None.

Items

Collection of CompanyTranslationItem

None.

VendorCategories

Collection of VendorCategory

None.

Notices

Collection of SiteNotice3

None.

Domains

Collection of string

None.

BannerSampleText

string

None.

ConsentToolSampleText

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "languageId": 3,
  "languageCode": "sample string 4",
  "updated": "2019-05-24T21:31:29.6653767+00:00",
  "updatedBy": "sample string 6",
  "items": [
    {
      "id": 1,
      "identifier": "sample string 2",
      "text": "sample string 3",
      "changed": true
    },
    {
      "id": 1,
      "identifier": "sample string 2",
      "text": "sample string 3",
      "changed": true
    }
  ],
  "vendorCategories": [
    {
      "id": 1,
      "languageId": 2,
      "identifier": "sample string 3",
      "category": "sample string 4",
      "changed": true
    },
    {
      "id": 1,
      "languageId": 2,
      "identifier": "sample string 3",
      "category": "sample string 4",
      "changed": true
    }
  ],
  "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"
            },
            {
              "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-24T21:31:29.6653767+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-05-24T21:31:29.6653767+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-24T21:31:29.6653767+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-05-24T21:31:29.6653767+00:00"
    }
  ],
  "domains": [
    "sample string 1",
    "sample string 2"
  ],
  "bannerSampleText": "sample string 7",
  "consentToolSampleText": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CompanyTranslation'.

Response Information

Resource Description

CompanyTranslation
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

LanguageId

integer

None.

LanguageCode

string

None.

Updated

date

None.

UpdatedBy

string

None.

Items

Collection of CompanyTranslationItem

None.

VendorCategories

Collection of VendorCategory

None.

Notices

Collection of SiteNotice3

None.

Domains

Collection of string

None.

BannerSampleText

string

None.

ConsentToolSampleText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "languageId": 3,
  "languageCode": "sample string 4",
  "updated": "2019-05-24T21:31:29.6810039+00:00",
  "updatedBy": "sample string 6",
  "items": [
    {
      "id": 1,
      "identifier": "sample string 2",
      "text": "sample string 3",
      "changed": true
    },
    {
      "id": 1,
      "identifier": "sample string 2",
      "text": "sample string 3",
      "changed": true
    }
  ],
  "vendorCategories": [
    {
      "id": 1,
      "languageId": 2,
      "identifier": "sample string 3",
      "category": "sample string 4",
      "changed": true
    },
    {
      "id": 1,
      "languageId": 2,
      "identifier": "sample string 3",
      "category": "sample string 4",
      "changed": true
    }
  ],
  "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"
            },
            {
              "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-24T21:31:29.6810039+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-05-24T21:31:29.6810039+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-24T21:31:29.6810039+00:00",
      "updatedBy": "sample string 17",
      "updated": "2019-05-24T21:31:29.6810039+00:00"
    }
  ],
  "domains": [
    "sample string 1",
    "sample string 2"
  ],
  "bannerSampleText": "sample string 7",
  "consentToolSampleText": "sample string 8"
}