BrandQuestions

APIDescription
GET Brands/{brandID}/Questions

Get BrandQuestionType using Brand ID

POST Brands/{brandID}/Questions

Adds BrandQuestionType to a brand with Brand ID

PUT Brands/{brandID}/Questions

Updates Brand Question Type Overrides

GET {authenticationKey}/{version}/BrandQuestions/HeartBeat

No documentation available.

Brands

This controller is used for creating and managing various aspects of Brands, BrandCountry, QuestionSet and Brand Criteria.

APIDescription
GET Brands?includeProperties={includeProperties}&includeCountries={includeCountries}

Get all Brands

GET Brands?brandGroupID={brandGroupID}&includeProperties={includeProperties}&includeCountries={includeCountries}

Get all Brands using Brand Group ID

GET Brands/Exists?brandName={brandName}

Check if a Brand exists

GET Brands?brandID={brandID}&includeProperties={includeProperties}&includeCountries={includeCountries}

Get Brand using Brand ID

POST Brands/Bulk?includeProperties={includeProperties}&includeCountries={includeCountries}

Get Brands using Brand IDs

GET Brands?brandGroupID={brandGroupID}&brandName={brandName}&includeProperties={includeProperties}&includeCountries={includeCountries}

Get Brand using Brand Group ID and the Brand Name

GET Brands?panelTypeID={panelTypeID}&memberTypeID={memberTypeID}&includeProperties={includeProperties}&includeCountries={includeCountries}

Get all brands corresponding to a given panel type ID.

GET Brands/Search?brandName={brandName}

Search for brands by brand name

POST Brands/GetCountryCultureIDs

Get Brands CountryIDs and CultureIDs using Brand IDs

POST Brands?brandGroupID={brandGroupID}

Create Brand for a given Brand Group ID

PUT Brands

Update Brand

PUT Brands/RefreshCache?resetDelta={resetDelta}

Refreshes Brand Cache

POST Brands/{brandID}/Properties

Create Properties for a given brandID.

DELETE Brands/{brandID}/Properties

Delete specific Properties to the given Brand ID.

PUT Brands/{brandID}/Properties

Update specific Properties to the given Brand ID.

GET {authenticationKey}/{version}/Brands/HeartBeat

No documentation available.

BrandCountryOpenSurveyIncentives

This controller is used for managing of Open Survey Incentives.

APIDescription
GET Brands/{brandID}/Countries/Bulk/OpenSurveyIncentives

Get all country specific Open Survey Incentives Activities for the Brand.

GET Brands/{brandID}/Countries/{countryID}/OpenSurveyIncentives

Get Open Survey Incentives Activity for the Brand and Country.

POST Brands/{brandID}/Countries/{countryID}/OpenSurveyIncentives

Add Open Survey Incentives Activity.

PUT Brands/{brandID}/Countries/{countryID}/OpenSurveyIncentives

Update Open Survey Incentives Activity.

DELETE Brands/{brandID}/Countries/{countryID}/OpenSurveyIncentives

Delete Open Survey Incentives Activity.

GET {authenticationKey}/{version}/BrandCountryOpenSurveyIncentives/HeartBeat

No documentation available.

BrandQuestionSetCountryCulture

APIDescription
GET Brands/{brandID}/QuestionSets/Country/Culture/All?questionSetID={questionSetID}

No documentation available.

GET Brands/{brandID}/QuestionSets/Country/Culture?questionSetID={questionSetID}&countryID={countryID}&cultureID={cultureID}

No documentation available.

POST Brands/{brandID}/QuestionSets/Country/Culture

No documentation available.

PUT Brands/{brandID}/QuestionSets/Country/Culture

No documentation available.

DELETE Brands/{brandID}/QuestionSets/Country/Culture?questionSetID={questionSetID}&countryID={countryID}&cultureID={cultureID}

No documentation available.

GET {authenticationKey}/{version}/BrandQuestionSetCountryCulture/HeartBeat

No documentation available.

SiteSettings

APIDescription
GET Brands/SiteSettings?siteSettingID={siteSettingID}

Get a site setting by site setting ID

GET Brands/SiteSettings?siteSettingIdentifier={siteSettingIdentifier}

Get a site setting by its identifier (SiteId)

POST Brands/SiteSettings

Adds/create a site setting.

PUT Brands/SiteSettings

Update a site setting.

DELETE Brands/SiteSettings?siteSettingID={siteSettingID}

Delete a site setting by site setting ID

DELETE Brands/SiteSettings?siteSettingIdentifier={siteSettingIdentifier}

Delete a site setting by its identifier (SiteId)

PUT Brands/SiteSettings/RefreshCache?resetDelta={resetDelta}

Refreshes SiteSettings Cache

GET {authenticationKey}/{version}/SiteSettings/HeartBeat

No documentation available.

BrandCountry

APIDescription
GET Brands/{brandID}/Countries?includeProperties={includeProperties}

Gets countries associated with a brand

GET Brands/{brandID}/Countries/{countryID}?includeProperties={includeProperties}

Gets details related to a brand country association.

POST Brands/{brandID}/Countries

Add Countries to the given Brand ID

PUT Brands/{brandID}/Countries

Update specific BrandCountry to the given Brand ID.

DELETE Brands/{brandID}/Countries

Deletes countries to the given Brand ID.

DELETE Brands/{brandID}/Countries/{countryID}

Delete specific BrandCountry to the given Brand ID and Country ID.

PUT Brands/Countries/RefreshCache?resetDelta={resetDelta}

Refreshes Brand country Cache

POST Brands/{brandID}/Countries/{countryID}/Properties

Adds specific Properties to the given Brand country

DELETE Brands/{brandID}/Countries/{countryID}/Properties

Delete specific Properties to the given Brand Country

PUT Brands/{brandID}/Countries/{countryID}/Properties

Update specific Properties to the given Brand Country

GET {authenticationKey}/{version}/BrandCountry/HeartBeat

No documentation available.

BrandCountrySiteIncentiveData

This controller is used for managing of Site Incentives.

APIDescription
GET Brands/{brandID}/Countries/Bulk/SiteIncentiveData?activityID={activityID}

Get all country specific Site Incentive Data for the Brand.

GET Brands/{brandID}/Countries/{countryID}/SiteIncentiveData?activityID={activityID}

Get the Site Incentive Data for the Brand and Country.

POST Brands/{brandID}/Countries/{countryID}/SiteIncentiveData

Create Site Incentive Data for the Brand and Country.

PUT Brands/{brandID}/Countries/{countryID}/SiteIncentiveData

Update Site Incentive Data for the Brand and Country.

DELETE Brands/{brandID}/Countries/{countryID}/SiteIncentiveData?activityID={activityID}

Delete Site Incentive Data for the Brand and Country.

GET {authenticationKey}/{version}/BrandCountrySiteIncentiveData/HeartBeat

No documentation available.

BrandSurveyPointsLimitGrid

This controller is used for managing of Survey Points Limit Grid.

APIDescription
GET Brands/{brandID}/SurveyPointsLimitGrid

Get default Survey Points Limit Grid for the Brand.

POST Brands/{brandID}/SurveyPointsLimitGrid

Create default Survey Points Limit Grid for the Brand from default group.

POST Brands/{brandID}/SurveyPointsLimitGrid?groupID={groupID}

Create default Survey Points Limit Grid for the Brand.

PUT Brands/{brandID}/SurveyPointsLimitGrid?groupID={groupID}

Update the group of default Survey Points Limit Grid for the Brand.

PUT Brands/{brandID}/SurveyPointsLimitGrid

Update default Survey Points Limit Grid for the Brand.

DELETE Brands/{brandID}/SurveyPointsLimitGrid

Delete Survey Points Limit Grid.

GET {authenticationKey}/{version}/BrandSurveyPointsLimitGrid/HeartBeat

No documentation available.

PageTypes

APIDescription
GET Brands/SiteSettings/PageTypes

Gets all page types.

GET Brands/SiteSettings/PageTypes?pageTypeID={pageTypeID}

Gets page type by its ID.

GET Brands/SiteSettings/PageTypes?pageTypeName={pageTypeName}

Gets page type by its Name.

POST Brands/SiteSettings/PageTypes

Add/Create a new page type.

PUT Brands/SiteSettings/PageTypes/RefreshCache?resetDelta={resetDelta}

Refreshes page types Cache

GET {authenticationKey}/{version}/PageTypes/HeartBeat

No documentation available.

BrandCulture

APIDescription
POST Brands/{brandID}/Countries/{countryID}/Cultures

Adds cultures supported for a Brand Country

PUT Brands/{brandID}/Countries/{countryID}/Cultures

Updated information related to a BrandCountryCulture

DELETE Brands/{brandID}/Countries/{countryID}/Cultures

Removes cultures supported for a BrandCountry

POST Brands/{brandID}/Countries/{countryID}/Cultures/{cultureID}/Properties

Adds specific Properties to the given Brand culture

DELETE Brands/{brandID}/Countries/{countryID}/Cultures/{cultureID}/Properties

Delete specific Properties to the given Brand culture

PUT Brands/{brandID}/Countries/{countryID}/Cultures/{cultureID}/Properties

Update specific Properties to the given Brand culture

GET {authenticationKey}/{version}/BrandCulture/HeartBeat

No documentation available.

BrandCountryTieredIncentiveGrid

This controller is used for managing Tiered Incentives Grids for the brand and specific country.

APIDescription
GET Brands/{brandID}/Countries/Bulk/TieredIncentivesGrid

Get all country specific Tiered Incentives Grids for the Brand.

GET Brands/{brandID}/Countries/{countryID}/TieredIncentivesGrid

Get the Tiered Incentives Grid for the Brand and Country.

POST Brands/{brandID}/Countries/{countryID}/TieredIncentivesGrid

Create Tiered Incentives Grid for the Brand and Country.

PUT Brands/{brandID}/Countries/{countryID}/TieredIncentivesGrid

Update Tiered Incentives Grid for the Brand and Country.

DELETE Brands/{brandID}/Countries/{countryID}/TieredIncentivesGrid

Delete Tiered Incentives Grid for the Brand and Country.

GET {authenticationKey}/{version}/BrandCountryTieredIncentiveGrid/HeartBeat

No documentation available.

BrandCountrySiteIncentivesActivity

This controller is used for managing of Activity data for Site Incentives.

APIDescription
GET SiteIncentivesActivity/{activityID}/CreditValues

Get the Credit Values of the Site Incentives Activity.

POST SiteIncentivesActivity/{activityID}/CreditValues

Create the Credit Values for the Site Incentives Activity.

PUT SiteIncentivesActivity/{activityID}/CreditValues

Update the Credit Values of the Site Incentives Activity.

DELETE SiteIncentivesActivity/{activityID}/CreditValues

Delete the Credit Values from the Site Incentives Activity.

GET {authenticationKey}/{version}/BrandCountrySiteIncentivesActivity/HeartBeat

No documentation available.

PanelTypes

APIDescription
GET PanelTypes

Gets all panel types

GET PanelTypes?panelTypeID={panelTypeID}

Get Panel Types for given panel type ID.

POST PanelTypes

Get Panel Types for given panel type IDs.

PUT PanelTypes/RefreshCache?resetDelta={resetDelta}

Refreshes PanelTypes cache.

GET {authenticationKey}/{version}/PanelTypes/HeartBeat

No documentation available.

BrandCountrySurveyPointsLimitGrid

This controller is used for managing of Survey Points Limit Grid.

APIDescription
GET Brands/{brandID}/Countries/Bulk/SurveyPointsLimitGrid

Get all country specific Survey Points Limit Grids for the Brand.

GET Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid

Get Survey Points Limit Grid for the Brand and Country.

POST Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid

Create Survey Points Limit Grid for the Brand and Country from default group.

POST Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid?groupID={groupID}

Create Survey Points Limit Grid for the Brand and Country.

PUT Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid?groupID={groupID}

Update the group of Survey Points Limit Grid for the Brand and Country.

PUT Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid

Update Survey Points Limit Grid for the Brand and Country.

DELETE Brands/{brandID}/Countries/{countryID}/SurveyPointsLimitGrid

Delete Survey Points Limit Grid for the Brand and Country.

GET {authenticationKey}/{version}/BrandCountrySurveyPointsLimitGrid/HeartBeat

No documentation available.

BrandGroupMemberDeDuplication

APIDescription
GET BrandGroups/{brandGroupID}/MemberDeduplicationCriteria

Gets all member deduplication criteria for given brand group

GET BrandGroups/{brandGroupID}/MemberDeduplicationCriteria?criteriaID={criteriaID}

Gets member deduplication criteria based on brandgroup id and criteria id

POST BrandGroups/{brandGroupID}/MemberDeduplicationCriteria

Create Member Deduplication Criteria for a brand group.

PUT BrandGroups/{brandGroupID}/MemberDeduplicationCriteria

Updates Member Deduplication Criteria for a brand group.

DELETE BrandGroups/{brandGroupID}/MemberDeduplicationCriteria?criteriaID={criteriaID}

Deletes a brand group member deduplication criteria

GET {authenticationKey}/{version}/BrandGroupMemberDeDuplication/HeartBeat

No documentation available.

BrandSiteIncentiveData

This controller is used for managing of Site Incentives.

APIDescription
GET Brands/{brandID}/SiteIncentiveData?activityID={activityID}

Get default Site Incentive Data for the Brand.

POST Brands/{brandID}/SiteIncentiveData

Add an Site Incentive Data.

PUT Brands/{brandID}/SiteIncentiveData

Update an Site Incentive Data.

DELETE Brands/{brandID}/SiteIncentiveData?activityID={activityID}

Delete an Site Incentive Data.

GET {authenticationKey}/{version}/BrandSiteIncentiveData/HeartBeat

No documentation available.

BrandQuestionSets

APIDescription
GET Brands/{brandID}/QuestionSets/PostRegistrationQuestionSets

Get Active PostRegistrationQuestionSet details using Brand ID. The returned list will no longer contain version information for Question Sets.

GET Brands/{brandID}/QuestionSets/{questionsetID}/IsPostRegistration

Verify if the brand questionset is used for post registration

GET Brands/{brandID}/QuestionSets/Details

Get Active QuestionSet details using Brand ID. The returned list will no longer contain version information for Question Sets.

GET Brands/{brandID}/QuestionSets

Get list of active Brand Question Set using Brand ID

GET Brands/{brandID}/QuestionSets/All

Get list of Brand Question Set using Brand ID

GET Brands/{brandID}/QuestionSets?questionSetID={questionSetID}

Get Brand Question Set using Brand ID and Question Set ID. This method is returning null response when brandid is not matching with questionsetID.

GET Brands/{brandID}/QuestionSets/{questionSetID}

Get Brand Question Set using Brand ID and Question Set ID. This new method throw an error when brandid is not matching with questionsetID instead of returning null response model.

GET Brands/{brandID}/QuestionSets/Sequence

Gets the sequence numbers of non-routable question sets for a brand.

PUT Brands/{brandID}/QuestionSets/Sequence

Sets the sequence numbers of non-routable question sets for a brand.

PUT Brands/{brandID}/QuestionSets/PostRegistrationSequence

Sets the sequence numbers of non-routable question sets for a brand.

GET Brands/{brandID}/QuestionSets/Registration?tag={tag}

Get Active Brand Question Set using Brand ID, and question set tag

GET Brands/{brandID}/QuestionSets/ByTag?tag={tag}

Get Active Brand Question Set using Brand ID, and question set tag

GET Brands/QuestionSets/{questionSetID}/exists

Checks if there exists any active brand question set by question set id.

GET Brands/QuestionSets/{questionSetID}/Exists/All

Checks if there exists any brand question set by question set id.

GET Brands/QuestionSets/{questionSetID}/Registration

Returns a list of Registration brands for a given Question Set. The returned list will have the brand ids for a given question set.

POST Brands/{brandID}/QuestionSets

Allows the caller to create a new QuestionSet for a given brand.

PUT Brands/{brandID}/QuestionSets

Modify specific Question Set for a given brand.

DELETE Brands/{brandID}/QuestionSets?questionSetID={questionSetID}

Delete specific Question Set for a given brand.

GET Brands/QuestionSets/{questionSetID}/IsUsedAsPostRegistration

Return whether the question set is used as post registration in any brand

GET {authenticationKey}/{version}/BrandQuestionSets/HeartBeat

No documentation available.

Health

APIDescription
GET Health/Status

No documentation available.

BrandCultureSiteIncentivesActivity

This controller is used for managing Translations for Site Incentives Activity.

APIDescription
POST SiteIncentivesActivity/{activityID}/GetTranslations

Get Translations of the Site Incentives Activity.

PUT SiteIncentivesActivity/{activityID}/SetTranslations

Save Translations of the Site Incentives Activity.

POST SiteIncentivesActivity/{activityID}/SetTranslations

Save Translations of the Site Incentives Activity.

DELETE SiteIncentivesActivity/{activityID}/Translations

Delete Translations of the Site Incentives Activity.

GET {authenticationKey}/{version}/BrandCultureSiteIncentivesActivity/HeartBeat

No documentation available.

SitePages

APIDescription
GET Brands/SiteSettings/{siteSettingID}/SitePages

Get all site pages for a site setting by site setting ID.

GET Brands/SiteSettings/SitePages?sitePageID={sitePageID}

Get a site page by site page ID

POST Brands/SiteSettings/SitePages/Bulk

Get site pages by a list of site page IDs

GET Brands/SiteSettings/SitePages?sitePageIdentifier={sitePageIdentifier}&siteSettingID={siteSettingID}

Get a site page by its identifier (pageId)

POST Brands/SiteSettings/SitePages

Adds a site page to a site setting

PUT Brands/SiteSettings/SitePages

Update a site page.

DELETE Brands/SiteSettings/SitePages?sitePageID={sitePageID}

Delete a site page by site page ID

DELETE Brands/SiteSettings/SitePages?sitePageIdentifier={sitePageIdentifier}&siteSettingID={siteSettingID}

Delete a site page by its Identifier

PUT Brands/SiteSettings/SitePages/RefreshCache?resetDelta={resetDelta}

Refreshes SitePages Cache

GET {authenticationKey}/{version}/SitePages/HeartBeat

No documentation available.

BrandGroups

This controller is used for creating and managing various aspects of Brand Groups and Brand Group Deduplication Criteria.

APIDescription
GET BrandGroups

Get all the Brand Groups

GET BrandGroups?brandGroupID={brandGroupID}

Get specific Brand Group for given brand group ID

GET BrandGroups/Exists?brandGroupName={brandGroupName}

Checks for the existence of a brand group by name.

PUT BrandGroups/RefreshCache?resetDelta={resetDelta}

Refreshes Brand group cache.

GET BrandGroups/Brands?brandID={brandID}

Get specific Brand Group for given brand ID

GET BrandGroups/MemberDeduplicationCriteriaQuestions

Gets ids for all questions used in deduplication criteria

POST BrandGroups

Create New Brand Group

PUT BrandGroups/{brandGroupID}

Modify specific Brand Group for given Brand Group ID

DELETE BrandGroups/{brandGroupID}

Delete specific Brand Group for given Brand Group ID

GET BrandGroups/HeartBeat

Will return a heartbeat indicating the each controller is alive.

BrandTieredIncentiveGrid

This controller is used for managing default Tiered Incentives Grid for the brand.

APIDescription
GET Brands/{brandID}/TieredIncentivesGrid

Get default Tiered Incentives Grid for the Brand.

POST Brands/{brandID}/TieredIncentivesGrid

Create default Tiered Incentives Grid for the Brand.

PUT Brands/{brandID}/TieredIncentivesGrid

Update default Tiered Incentives Grid for the Brand.

DELETE Brands/{brandID}/TieredIncentivesGrid

Delete default Tiered Incentives Grid for the Brand.

GET {authenticationKey}/{version}/BrandTieredIncentiveGrid/HeartBeat

No documentation available.

BrandGroupsQuestions

APIDescription
GET BrandGroups/{brandGroupID}/Questions

Get Question Types defined for the BrandGroup.

POST BrandGroups/{brandGroupID}/Questions

Adds QuestionType override to a BrandGroup

PUT BrandGroups/{brandGroupID}/Questions

Updates Question Type Overrides of a BrandGroup

GET {authenticationKey}/{version}/BrandGroupsQuestions/HeartBeat

No documentation available.

BrandSiteSettings

APIDescription
GET Brands/{brandID}/BrandSiteSettings

Get all brand site setting by brand ID.

POST Brands/BrandSiteSettings

Add/Associate site settings to a brand

DELETE Brands/BrandSiteSettings

Delete/De-associate site settings from a brand

DELETE Brands/BrandSiteSettings?brandID={brandID}&siteSettingIDs[0]={siteSettingIDs[0]}&siteSettingIDs[1]={siteSettingIDs[1]}

Delete/De-associate site settings from a brand

PUT Brands/BrandSiteSettings/RefreshCache?resetDelta={resetDelta}

Refreshes BrandSiteSettings Cache

GET {authenticationKey}/{version}/BrandSiteSettings/HeartBeat

No documentation available.

BrandOpenSurveyIncentives

This controller is used for managing of Open Survey Incentives.

APIDescription
GET Brands/{brandID}/OpenSurveyIncentives

Get default Open Survey Incentives Activity for the Brand.

POST Brands/{brandID}/OpenSurveyIncentives

Create default Open Survey Incentives Activity for the Brand.

PUT Brands/{brandID}/OpenSurveyIncentives

Update default Open Survey Incentives Activity for the Brand.

DELETE Brands/{brandID}/OpenSurveyIncentives

Delete default Open Survey Incentives Activity for the Brand.

GET {authenticationKey}/{version}/BrandOpenSurveyIncentives/HeartBeat

No documentation available.

BrandSiteIncentivesActivity

This controller is used for managing of Activity data for Site Incentives.

APIDescription
GET SiteIncentivesActivity?brandID={brandID}

Get all Site Incentives Activities for the Brand.

GET SiteIncentivesActivity/{id}

Get Site Incentives Activity by it's ID

GET SiteIncentivesActivity?brandID={brandID}&internalName={internalName}

Get Site Incentives Activity for the Brand by it's internal name.

POST SiteIncentivesActivity

Add an Site Incentives Activity.

PUT SiteIncentivesActivity/{id}

Update an Site Incentives Activity.

DELETE SiteIncentivesActivity/{id}

Delete an Site Incentives Activity.

GET {authenticationKey}/{version}/BrandSiteIncentivesActivity/HeartBeat

No documentation available.