POST api/v3/consenttest

Saves a Consent Test to the database

Request Information

URI Parameters

None.

Body Parameters

Ghostery.Privacy.Common.Objects.Site3.ConsentTest
NameDescriptionTypeAdditional information
Id

integer

None.
CompanyId

integer

None.
SiteNoticeId

integer

None.
SiteNoticeCountryId

integer

None.
GeonameId

integer

None.
Name

string

Required
Notes

string

None.
StartDate

date

None.
StartConsentRate

integer

None.
EndDate

date

None.
EndConsentRate

integer

None.
ConsentTestStatusId

integer

None.
ConsentTestTypeId

integer

None.
ConsentTestValue

string

None.
ConsentTestOldValue

string

None.
NotificationSentDate

date

None.
ResultKept

boolean

None.
ResultDate

date

None.
SiteNoticeDomain

string

None.
SiteNoticeCountryName

string

None.
ConsentTestStatusName

string

None.
ConsentTestTypeName

string

None.
CreatorEmail

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "companyId": 2,
  "siteNoticeId": 3,
  "siteNoticeCountryId": 1,
  "geonameId": 1,
  "name": "sample string 4",
  "notes": "sample string 5",
  "startDate": "2024-12-30T17:33:03.4622696+00:00",
  "startConsentRate": 7,
  "endDate": "2024-12-30T17:33:03.4622696+00:00",
  "endConsentRate": 1,
  "consentTestStatusId": 9,
  "consentTestTypeId": 10,
  "consentTestValue": "sample string 11",
  "consentTestOldValue": "sample string 12",
  "notificationSentDate": "2024-12-30T17:33:03.4622696+00:00",
  "resultKept": true,
  "resultDate": "2024-12-30T17:33:03.4622696+00:00",
  "siteNoticeDomain": "sample string 13",
  "siteNoticeCountryName": "sample string 14",
  "consentTestStatusName": "sample string 15",
  "consentTestTypeName": "sample string 16",
  "creatorEmail": "sample string 17"
}

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

Response Information

Resource Description

Ghostery.Privacy.Common.Objects.Site3.ConsentTest
NameDescriptionTypeAdditional information
Id

integer

None.
CompanyId

integer

None.
SiteNoticeId

integer

None.
SiteNoticeCountryId

integer

None.
GeonameId

integer

None.
Name

string

Required
Notes

string

None.
StartDate

date

None.
StartConsentRate

integer

None.
EndDate

date

None.
EndConsentRate

integer

None.
ConsentTestStatusId

integer

None.
ConsentTestTypeId

integer

None.
ConsentTestValue

string

None.
ConsentTestOldValue

string

None.
NotificationSentDate

date

None.
ResultKept

boolean

None.
ResultDate

date

None.
SiteNoticeDomain

string

None.
SiteNoticeCountryName

string

None.
ConsentTestStatusName

string

None.
ConsentTestTypeName

string

None.
CreatorEmail

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "companyId": 2,
  "siteNoticeId": 3,
  "siteNoticeCountryId": 1,
  "geonameId": 1,
  "name": "sample string 4",
  "notes": "sample string 5",
  "startDate": "2024-12-30T17:33:03.4622696+00:00",
  "startConsentRate": 7,
  "endDate": "2024-12-30T17:33:03.4622696+00:00",
  "endConsentRate": 1,
  "consentTestStatusId": 9,
  "consentTestTypeId": 10,
  "consentTestValue": "sample string 11",
  "consentTestOldValue": "sample string 12",
  "notificationSentDate": "2024-12-30T17:33:03.4622696+00:00",
  "resultKept": true,
  "resultDate": "2024-12-30T17:33:03.4622696+00:00",
  "siteNoticeDomain": "sample string 13",
  "siteNoticeCountryName": "sample string 14",
  "consentTestStatusName": "sample string 15",
  "consentTestTypeName": "sample string 16",
  "creatorEmail": "sample string 17"
}