POST api/v1/company/categorybucket/{languageId}

Saves a provided category bucket.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
languageId

The language identifier.

integer

Required

Body Parameters

The company category bucket.

Ghostery.Privacy.Common.Objects.Company.CompanyCategoryBucket
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Description

string

None.

IsEssential

boolean

None.

IsDataSharing

boolean

None.

VendorCategories

Collection of Ghostery.Privacy.Common.Objects.Company.VendorCategory

None.

Translations

Collection of Ghostery.Privacy.Common.Objects.Company.CompanyCategoryBucketTranslation

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isEssential": true,
  "isDataSharing": 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
    }
  ],
  "translations": [
    {
      "languageId": 1,
      "languageName": "sample string 2",
      "browserCode": "sample string 3",
      "nameText": "sample string 4",
      "descriptionText": "sample string 5"
    },
    {
      "languageId": 1,
      "languageName": "sample string 2",
      "browserCode": "sample string 3",
      "nameText": "sample string 4",
      "descriptionText": "sample string 5"
    }
  ]
}

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

Response Information

Resource Description

Ghostery.Privacy.Common.Objects.Company.CompanyCategoryBucket
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Description

string

None.

IsEssential

boolean

None.

IsDataSharing

boolean

None.

VendorCategories

Collection of Ghostery.Privacy.Common.Objects.Company.VendorCategory

None.

Translations

Collection of Ghostery.Privacy.Common.Objects.Company.CompanyCategoryBucketTranslation

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isEssential": true,
  "isDataSharing": 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
    }
  ],
  "translations": [
    {
      "languageId": 1,
      "languageName": "sample string 2",
      "browserCode": "sample string 3",
      "nameText": "sample string 4",
      "descriptionText": "sample string 5"
    },
    {
      "languageId": 1,
      "languageName": "sample string 2",
      "browserCode": "sample string 3",
      "nameText": "sample string 4",
      "descriptionText": "sample string 5"
    }
  ]
}