SiteNoticev3

Contains the actions which allow interaction with the Site Notice version used for our Universal Consent platform.

APIDescription
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.

GET api/v3/sitenotice/scancounts

Returns the active scan counts for your company. This allows you to pull the counts to make sure you are still operating within your contract limits.

GET api/v3/sitenotice/{id}/delete

Deletes the site notice with the specified id value. When a notice is deleted it disables the notice for the specified domain and clears out the settings stored on our CDN. This will disable the notice within a few minutes.

GET api/v3/sitenotice/{id}

Retrieves the details for the specified site notice.

POST api/v3/sitenotice

Saves the given site notice. If the passed in site notice has a non-zero identifier this call will act as an update. A missing or 0 id value will cause a new notice to be inserted. The passed in notice structure will be validated and if there are errors the return status code will be 500 and the return content will be a list of validation issues.

GET api/v3/sitenotice/settings?domain={domain}

Recreates the settings file for SiteNotice v3 for a specific company and domain.

GET api/v3/sitenotice/tag

Pulls the universal script tag for the active company.

GET api/v3/sitenotice/tag/{tagId}

Pulls the specified tag for the active company.

GET api/v3/sitenotice/admin/theme

Pulls the list of company themes which can be assigned to a site notice. This list contains the theme names and id values. It also contains the domains being used for each theme.

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

Pulls the details for a site notice theme.

POST api/v3/sitenotice/admin/theme

Saves the site notice theme. This action behaves like an upsert. If the id value is missing or 0 the operation will create a new theme record. Otherwise this will try to modify the existing theme.

GET api/v3/sitenotice/admin/theme/{id}/delete

Deletes the specified theme, based on the passed in identifier. Note the attempt to delete will fail if there are still notices using the theme.

GET api/v3/sitenotice/admin/consenttool

Pulls the list of consent tool themes.

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

Pulls the details for the specified consent tool theme.

POST api/v3/sitenotice/admin/consenttool

Saves the consent tool theme. This action behaves as an upsert action. If the id value is missing or 0 this will create a new consent tool theme. If the id value is present it will attempt to modify the existing theme.

AdNotice

Methods to interact with your companies Ad Notice records.

APIDescription
GET api/v1/adnotice

Pulls the list of Ad Notices for your company. This query returns a simple list of notice information which includes the Id, Name, Country List, Status and Division. The Status is important. If the status is 1 the Ad Notice is active in production. If the status is 0 it is a draft notice.

GET api/v1/adnotice/{id}

Pulls the Ad Notice specified by the given identifier. This will include all the information about the ad notice with all settings.

POST api/v1/adnotice

Saves the Ad Notice.

GET api/v1/adnotice/copy/{noticeId}

Generates an Ad Notice which is a copy of the notice specified by the passed in notice identifier. The copied notice is returned from this call.

GET api/v1/adnotice/name/{noticeName}

No documentation available.

GET api/v1/adnotice/creative

Deprecated. Do not use.

POST api/v1/adnotice/creative/{noticeId}

Deprecated. Do not use.

POST api/v1/adnotice/tag

Pulls the ad notice tags for the passed in notice types and ad sizes.

POST api/v1/adnotice/archive

Deprecated. Do not use.

GET api/v1/adnotice/account

Deprecated. Do not use.

POST api/v1/adnotice/account

Deprecated. Do not use.

Auth

APIDescription
POST api/v1/auth/login

No documentation available.

POST api/v1/auth/password/reset

No documentation available.

POST api/v1/auth/password/update

No documentation available.

POST api/v1/auth/password/change

No documentation available.

Gdpr

APIDescription
POST api/v3/gdpr

No documentation available.

GET api/v3/gdpr/verifyemail/{requestIdentifier}

No documentation available.

GET api/v3/gdpr/updatestatus?requestId={requestId}&status={status}

No documentation available.

GET api/v3/gdpr?productId={productId}&includeVerified={includeVerified}&includeUnverified={includeUnverified}

No documentation available.

Company

Contains the actions which can be executed against company level information (translations for example). This does not contain CRUD mechanisms for the actual company records. Those are found in the admin controller.

APIDescription
GET api/v1/company/translation/group/{id}/copy

Executes a copy operation, creating a new translation group based on the translation group identifier provided. The newly created group is returned to the caller.

GET api/v1/company/translation/group/{id}/delete

Deletes a company translation group. This operation will only succeed if the translation group you are trying to remove is not assigned to an active site notice.

POST api/v1/company/translation/group

Saves the passed in translation group. This operation is very limited in what it can do. The only thing this actually saves is the name of the group. If you want to change the actual translation values you need to open the specific translation, modify the desired values, and then save that company translation individually.

GET api/v1/company/translation/group/{id}/vendorcategory/{translationid}

Pulls the list of vendor categories for the specified company translation. This method allows the vendor categories to be pulled separate from the main company translation.

GET api/v1/company/categorybucket/inprogress/{languageId}

Pulls the list of in progress category buckets for a company

GET api/v1/company/categorybucket/inprogress/{companyCategoryBucketId}/{languageId}

Pulls one in progress category bucket for a company

GET api/v1/company/categorybucket/vendorcategories/{languageId}

Pulls vendor categories and translations from default translation set in english for use in bucketing.

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

Saves a provided category bucket

GET api/v1/company/categorybucket/{id}/delete

No documentation available.

GET api/v1/company/categorybucket/publish

No documentation available.

GET api/v1/company/categorybucket/publisheddate

No documentation available.

GET api/v1/company/translation/{id}

Pulls the specified company translation record.

GET api/v1/company/translation

Pulls the list of Company Translation Groups for your company.

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.

POST api/v1/company/translation/export

Given a set of translation ids, a CSV formatted file will be returned.

POST api/v1/company/translation/import

Given a csv file string containing translations to be inserted.

GET api/v1/company/image/{id}

Pulls the details for the image asset with the passed in identifier.

GET api/v1/company/image

Pulls the list of company image assets for your company.

POST api/v1/company/image

Saves the passed in company image. If an array of image data (the Source property) is passed in that will be uploaded into our CDN for distribution. If the new image is being passed into an existing image record that will trigger an overwrite of the old image assigned to this record with the new one. So only do that if you are trying to swap out an image globally.

DELETE api/v1/company/image/{id}

Deletes the specified image record.

GET api/v1/company/consentreport

Pulls a list of recent consent reports which have been generated for this company.

POST api/v1/company/consentreport

Saves a consent report execution record. Keeping a list of these will allow the contents of the reports to be available for retrieval at a future date.

Option

APIDescription
GET api/v1/option/country

No documentation available.

GET api/v1/option/language/{countryId}

No documentation available.

GET api/v1/option/overlaytemplate

No documentation available.

GET api/v1/option/advertiser

No documentation available.

GET api/v1/option/adsize

No documentation available.

GET api/v1/option/tagtype

No documentation available.

GET api/v1/option/translation/optout/{languageId}

No documentation available.

GET api/v1/option/translation/overlay/{languageId}

No documentation available.

GET api/v1/option/translation/sitenotice/{LanguageId}

No documentation available.

GET api/v1/option/domain

No documentation available.

GET api/v1/option/font

No documentation available.

SiteNotice

APIDescription
GET api/v1/sitenotice

No documentation available.

GET api/v1/sitenotice/{id}

No documentation available.

POST api/v1/sitenotice

No documentation available.

GET api/v1/sitenotice/{id}/delete

Deletes the site notice, removing it from the list of notices and disabling it from working.

GET api/v1/sitenotice/{id}/tag

No documentation available.

POST api/v1/sitenotice/find

No documentation available.

Vendor

APIDescription
GET api/v1/vendor

No documentation available.

GET api/v1/vendor/links

No documentation available.

GET api/v1/vendor/links/save

No documentation available.

GET api/v1/vendor/adserver

No documentation available.

GET api/v1/vendor/mobile

No documentation available.

Country

APIDescription
GET api/v1/country

No documentation available.

GET api/v1/country/proxy

No documentation available.

AppNotice

APIDescription
GET api/v1/appnotice

No documentation available.

GET api/v1/appnotice/{id}

No documentation available.

POST api/v1/appnotice

No documentation available.

GET api/v1/appnotice/configuration

This method is called explicitly to pull the information needed for the mobile app developer. Currently that consists of the id's (notice and company) as well as the list of vendors.

GET api/v1/appnotice/{id}/delete

No documentation available.

GET api/v1/appnotice/GdprAccessRequestsEnabled?appNoticeId={appNoticeId}

This method should be used to decide whether an AppNotice should display the GDPR Access Request functionality based on if a company has configured it to do so.

POST api/v1/appnotice/GdprAccessRequest

This method is used to create a GDPR Access Request

GET api/v1/appnotice/config

Asynchronously gets the AppNotice Configuration without vendors list attached.