Questions

APIDescription
GET Questions/{questionID}?statusType={statusType}&includeCultures={includeCultures}&includeChildren={includeChildren}&includeProperties={includeProperties}

Returns question.

GET Questions/{questionID}/Table

Returns the table id in which the member responses to this question are saved.

GET Questions/{questionID}/Properties?propertyName={propertyName}

Gets the value of a property for a question

GET Questions/{questionID}/IsActive

Returns true if question is active

GET Questions/{questionID}/Cultures?statusType={statusType}

Returns a list of Culture IDs associate with a given Question ID.

GET Questions/{questionID}/ChildQuestions?statusType={statusType}

Returns a list of child questions in a container question version. If the version is not mentioned, then the latest version of the question is considered.

GET Questions/{questionID}/RenderableCultures?statusType={statusType}

Returns a list of culture ids for the renderable cultures for a given question. If the version is not mentioned, then the active version of the question is considered.

GET Questions/{questionID}/IsRenderableInCulture/{cultureID}?statusType={statusType}

Returns true if a question is renderable in the given culture

GET Questions/{questionID}/InCulture/{cultureID}?statusType={statusType}&includeProperties={includeProperties}

Returns a question, which will have translated display names and HelpText in the culture provided.

GET Questions/Deduplication

Get Questions eligible for deduplication

GET Questions/Routable

Gets all routable questions

POST Questions/Bulk

Returns the active version of questions by Questionids.

POST Questions/Draft/Bulk

Returns the questions drafts.

POST Questions/AreAnyQuestionsPII

Returns true if any active questions with the given IDs are PII questions

GET Questions?internalName={internalName}

Returns an active version of the question by name

POST Questions/InternalNames

Returns an active version of the questions by names

GET Questions/InternalNameExist?internalName={internalName}

Checks to see if the request question internal name is used.

GET Questions/SearchByDisplayName?displayName={displayName}&allowDateAnswerTypes={allowDateAnswerTypes}

Returns a list of latest questions with display names containing the input provided.

GET Questions/SearchByInternalName?internalName={internalName}

Returns list of latest questions with internal names containing the input provided.

GET Questions/SearchByInternalNameByAllStatuses?internalName={internalName}

Returns list of questions with internal names containing the input provided.

GET Questions/Categories

Returns list of all question categories

GET Questions/Categories?categoryID={categoryID}

Returns a Question Category based on the categoryId provided.

POST Questions/Categories/Translations/Bulk

Gets the categories with translations based on the given category IDs and culture IDs. Returns empty when there is no translations available.

GET Questions?categoryID={categoryID}

Returns a list of all active questions based on the categoryID provided.

POST Questions/AllInCategories

Returns a list of all active questions based on the categoryIDs provided.

GET Questions/Categories/{categoryID}/Search?searchString={searchString}

Search latest questions in a category by questionDisplayName

POST Questions/SearchByProperty

Searches for Active questions by property name, value.

POST Questions/Translations/Bulk

Returns Translated Display Names for a collection of questions with a collections of cultures

GET Questions/ComputedType?countryID={countryID}

Gets all active computed questions that are valid for the given country along with answers.

GET Questions/ComputedQuestions

Returns all active computed question IDs with question set ID.

POST Questions/GetDisplayNames

Returns list of display names for questionsIDs

POST Questions/GetInternalNames

Returns list of display names for questionsIDs

POST Questions/Internal/Answers

Returns answers for active questions

PUT Questions

Updates the question and return the version updated.

PUT Questions/Status

Updates the status of a question.

PUT Questions/{questionID}/Culture/{cultureID}/Status/{statusType}

Updates the status of the question culture.

PUT Questions/{questionID}/ChildQuestion/{childQuestionID}/Status/{statusType}

Updates the status of the child question.

PUT Questions/{questionID}/Translations

Updates translations of a question.

PUT Questions/{questionID}/RegularExpressions

Updates the answer validation regular expressions specific to cultures of a question.

PUT Questions/{questionID}/ChildQuestions

Updates the sequence number, required property of a child question in a container question and returns the updated status type of the question. Rules of versioning apply to this method.

PUT Questions/{questionID}/Properties

Updates Properties of a question

PUT Questions/Categories

Updates an existing Question Category

PUT Questions/Categories/{categoryID}/Translations

Updates category translations based on the given category id and translations.

PUT Questions/RefreshCache?resetDelta={resetDelta}

Refreshes Cache

PUT Questions/RefreshTranslationsCache?resetDelta={resetDelta}

Refreshes Translations Cache

POST Questions

Creates a version one of the question in draft status, along with cultures and translations.

POST Questions/{questionID}/Cultures

Adds new cultures along with translations to the question and returns the version updated. Throws an error code if all the input cultures already exist in a questions. Rules of versioning apply to this method.

POST Questions/{questionID}/ChildQuestions

Adds existing questions as a child question to a container question. Returns the version of the question updated. Rules of version apply.

POST Questions/{questionID}/Properties

Adds properties to question

POST Questions/Categories

Creates a new Question Category

DELETE Questions?questionID={questionID}

Deletes a question. Throws an error when trying to delete a question which is a part of a live question set.

DELETE Questions/Draft?questionID={questionID}

Deletes a draft version of a question. Throws an error code when trying to delete a question which is a part of a live question set.

DELETE Questions/{questionID}/Cultures

Removes existing cultures and translations from a question and returns the version updated. Throws an error code if all the input cultures do not exist in a questions. Rules of versioning apply to this method.

DELETE Questions/{questionID}/Culture/{cultureID}/Translation?createDraftIfNotExists={createDraftIfNotExists}&isHelpText={isHelpText}&isDisplayName={isDisplayName}

Removes existing translations from a question Throws an error code if all the input cultures do not exist in a questions. If isHelptext is true it will delete help text other wise it will not delete. If isDisplayName is true it will delete the display name otherwise it will not delete.

DELETE Questions/{questionID}/ChildQuestions

Removes existing child questions from a container question and returns the version updated. Throws an error code if all the input questions do not exist in a container question. Rules of version apply to this method.

DELETE Questions/Categories?categoryID={categoryID}

Deletes a Question Category

DELETE Questions/Categories/{categoryID}/Translations

Deletes category translations based on the given category id and culture ids.

DELETE Questions/{questionID}/Properties

Delete question properties

GET {authenticationKey}/{version}/Questions/HeartBeat

No documentation available.

Health

APIDescription
GET Health/Status

No documentation available.

QuestionSetCriteria

APIDescription
GET QuestionSets/{questionSetID}/Criteria?isLive={isLive}&includeDescription={includeDescription}

Returns a list of criteria for a specific version of question set. If the version is not mentioned, then the latest is considered.

POST QuestionSets/Criteria/Bulk

Returns a list of live criteria for a many question sets

POST QuestionSets/Criteria/Draft/Bulk

Returns a list of draft criteria for a many question sets

POST QuestionSets/{questionSetID}/Criteria

Creates a criteria for a question set. If the latest question set is live, then a new version of question set is created else the latest version is updated. The version before is locked for edit before creating a new version. Returns the version of the question set updated.

POST QuestionSets/{questionSetID}/Criteria/Criterion

Adds new criterion list to an existing criteria of a question set and returns the version updated. Rules of versioning apply to this method.

DELETE QuestionSets/{questionSetID}/Criteria/Criterion?criteriaID={criteriaID}&criterionID={criterionID}

Removes existing criterion from a criteria of a question set and returns the version updated. Rules of versioning apply to this method.

PUT QuestionSets/{questionSetID}/Criteria/Status?criteriaID={criteriaID}&isLive={isLive}

Updates existing criterion and returns the updated question set version number. Rules of versioning apply to this method.

PUT QuestionSets/{questionSetID}/Criteria/Criterion

Updates existing criterion and returns the updated question set version number. Rules of versioning apply to this method.

DELETE QuestionSets/{questionSetID}/Criteria?criteriaID={criteriaID}

Deletes a question set criteria.

PUT QuestionSets/Criteria/RefreshCache?resetDelta={resetDelta}

Refreshes Cache

GET {authenticationKey}/{version}/QuestionSetCriteria/HeartBeat

No documentation available.

QuestionSets

Provides interfaces for creating and managing various aspects of a Question Set.

APIDescription
POST QuestionSets

Creates a version one of the question set in offline status, along with cultures and translations.

POST QuestionSets/Questions

Adds new questions to question set and returns the version updated. Throws an error code if all the input questions already exist in a questions set. Rules of versioning apply to this method.

POST QuestionSets/Questions/Translations

Adds new questions to question set and returns the version updated. Throws an error code if all the input questions already exist in a questions set. Rules of versioning apply to this method.

POST QuestionSets/Cultures

Adds new cultures along with translations to the question set and returns the version updated. Throws an error code if all the input cultures already exist in a questions set. Rules of versioning apply to this method.

POST QuestionSets/{questionSetID}/Properties

Adds properties to a questionset.

DELETE QuestionSets?questionSetID={questionSetID}

Deletes a question set. Throws an error code when trying to delete a live question set.

DELETE QuestionSets/Draft?questionSetID={questionSetID}

Deletes a draft of a question set. Throws an error code when trying to delete a live question set.

DELETE QuestionSets/{questionSetID}/Culture/{cultureID}/Translation?createDraftIfNotExists={createDraftIfNotExists}&isIntroductoryText={isIntroductoryText}&isDisplayName={isDisplayName}

Removes existing translations from a questionset Throws an error code if all the input cultures do not exist in a questions. If isHelptext is true it will delete help text other wise it will not delete. If isDisplayName is true it will delete the display name otherwise it will not delete.

DELETE QuestionSets/{questionSetID}/Properties

Delete question set properties

GET QuestionSets/IsRoutable?questionSetID={questionSetID}

Returns true for a QS that is Routable

GET QuestionSets

Returns a list of all live question sets with minimal details. Returns an empty collection if no live question sets.

GET QuestionSets?questionSetID={questionSetID}&includeCultures={includeCultures}&includeQuestions={includeQuestions}&includeProperties={includeProperties}

Returns a live version of the question set.

POST QuestionSets/Bulk

Returns a live question sets by it's IDs.

GET QuestionSets/{questionSetID}/Translated?cultureID={cultureID}&statusType={statusType}&useFallbackCultureForTranslations={useFallbackCultureForTranslations}&includeQuestions={includeQuestions}&includeProperties={includeProperties}

The question set will have translated display names and introductory text in the culture provided.

POST QuestionSets/Translations/Bulk

Gets the translations for live question sets based on the question set ids and culture ids. Returns empty translations, when either there are no translations available or the given cultures are not supported.

GET QuestionSets/{questionSetID}/Questions?cultureID={cultureID}&statusType={statusType}&useFallbackCultureForTranslations={useFallbackCultureForTranslations}

Returns a list of questions in a Question Set version. If the version is not mentioned, then the live version of the question set is considered. The returned list will have the Unique ID and translated display name of the question. Returns an empty list if no questions in a question set.

POST QuestionSets/GetRenderableInCulture

Returns a list of the ids of all passed QuestionSet ids whose active versions are renderable in the given culture

GET QuestionSets/{questionSetID}/RenderableCultures?statusType={statusType}

Returns a list of culture unique ids for renderable cultures for a given question set. If the version is not mentioned, then the latest version of the question set is considered.

GET QuestionSets/SearchByDisplayName?displayName={displayName}

Returns a list of live question sets with display names containing the input provided.

GET QuestionSets/SearchByInternalName?internalName={internalName}

Returns list of live questionsets with internal names containing the input provided.

GET QuestionSets/SearchByInternalNameByAllStatuses?internalName={internalName}

Returns list of questionsets with internal names containing the input provided.

GET QuestionSets/{questionSetID}?statusType={statusType}&includeCultures={includeCultures}&includeQuestions={includeQuestions}&includeProperties={includeProperties}

Returns a question set of specific status

POST QuestionSets/Draft/Bulk

Returns the draft question set.

GET QuestionSets/{questionSetID}/Questions?statusType={statusType}

Returns a Dictionary of Questionid and the status of question in a Question Set. If the status of questionset is not mentioned, then live question set is considered.

GET QuestionSets/{questionSetID}/Questions/Required?statusType={statusType}

Returns a list of required questions in a Question Set. If the status is not mentioned, then live question set is considered.

GET QuestionSets/{questionSetID}/Questions/Search?displayName={displayName}

Search for questions in a live question set by question display name

GET QuestionSets/{questionSetID}/DisplayInformation?statusType={statusType}

Returns the display information of a question in a questionset.

POST QuestionSets/ForQuestions

Returns a collection of live QuestionSetIDs in which the question is present.

GET QuestionSets/{questionSetID}/Statistics?statusType={statusType}&includeChildQuestions={includeChildQuestions}

Returns statistics of a questionset by status.

GET QuestionSets/InternalNameExist?internalName={internalName}

Checks to see if the request question set internal name is used.

GET QuestionSets/{questionSetID}/Properties?propertyName={propertyName}

Gets the value of a property for a questionset.

PUT QuestionSets/Status

Updates the status of a question set

PUT QuestionSets/Question/Status

Updates the status of a question in a question set

PUT QuestionSets/Culture/Status

Updates the status of a culture in a question set

PUT QuestionSets

Updates the question set and return the version updated. Rules of versioning apply to this method.

POST QuestionSets/Questions/Remove

Removes existing questions from a question set and returns the version updated. Throws an error code if all the input questions do not exist in a questions set. Rules of versioning apply to this method.

POST QuestionSets/Cultures/Remove

Removes existing cultures and translations from a question set and returns the version updated. Throws an error code if all the input cultures do not exist in a questions set. Rules of versioning apply to this method.

PUT QuestionSets/Translations

Updates translations of a question set and returns the version updated. Throws an error code if all the input cultures do not exist in a questions set. Rules of versioning apply to this method.

PUT QuestionSets/Questions/Translations

Updates translations of a question specific to the question set

PUT QuestionSets/Question/DisplayInformation

Updates the display information of a question in a question set and returns the updated version of the question set. Rules of versioning apply to this method.

PUT QuestionSets/{questionSetID}/Questions

Updates the display information of a questions in a question set and returns the updated version of the question set.

PUT QuestionSets/{questionSetID}/TransferLock?userUniqueID={userUniqueID}

Transfers lock of a Draft questionset to another user.

PUT QuestionSets/{questionSetID}/Properties

Updates properties for a questionset.

PUT QuestionSets/RefreshCache?resetDelta={resetDelta}

Refreshes Cache

PUT QuestionSets/RefreshTranslationsCache?resetDelta={resetDelta}

Refreshes Translations Cache

GET QuestionSets/HeartBeat

No documentation available.

RoutableQuestionSets

Provides interfaces for creating and managing various aspects of Routable Question Sets.

APIDescription
GET Routable/QuestionSets

Gets All live Routable QuestionSets

GET Routable/QuestionSets?panelTypeID={panelTypeID}

Gets All live Routable QuestionSets for a specific panel type

GET Routable/QuestionSets?questionSetID={questionSetID}&includeCultures={includeCultures}&includeQuestions={includeQuestions}&includeProperties={includeProperties}

Returns a live version of the question set. Throws bad request if question set does not exist.

POST Routable/QuestionSets/ForQuestions

Returns live routable questionsets for questions

POST Routable/QuestionSets

Creates a version one of the question set in draft status, along with cultures and translations.

PUT Routable/QuestionSets

Updates the question set and return the version updated. Rules of versioning apply to this method.

DELETE Routable/QuestionSets?questionSetID={questionSetID}

Deletes a question set. Throws an error code when trying to delete a live question set.

POST Routable/QuestionSets/Questions

Adds new questions to question set and returns the version updated. Throws an error code if all the input questions already exist in a questions set. Rules of versioning apply to this method.

POST Routable/QuestionSets/Questions/Remove

Removes existing questions from a question set and returns the version updated. Throws an error code if all the input questions do not exist in a questions set. Rules of versioning apply to this method.

GET Routable/QuestionSets/HeartBeat

No documentation available.

Answers

APIDescription
GET Answers/InternalNameUsed?questionID={questionID}&internalName={internalName}

Checks if the answer internal name is unique for a question or not

POST Answers/Bulk

Returns answer details for each answer in the collection.

GET Answers?questionID={questionID}&questionStatusType={questionStatusType}&includeProperties={includeProperties}

Returns a list of all active answers for a respective active/offline question type. Returns a list of all active and inactive answers for a respective draft question type.

POST Answers/ByQuestion/Bulk

Returns a list of all active answers for a respective active/offline question type. Returns a list of all active and inactive answers for a respective draft question type.

GET Answers/ParentQuestions?filterQuestionID={filterQuestionID}

Returns a list of questions that need to be answered for a filtered answer that is dependent on a combination of answers. The input to this method is the Unique ID of the filtered answer question. The returned list contains parent questionIds

GET Answers/Search?internalName={internalName}&includeInactiveAnswers={includeInactiveAnswers}

OBSOLETE - Returns a list of active answers by internal name.

POST Answers/Translations/Bulk

Returns translations of an answer for the requested cultures

POST Answers/Cultures

Returns list of available cultures for each answerid provided.

POST Answers/GetCulturesInfo

Returns cultures information for the answers. If no culture IDs provided, all existed answer cultures will be returned.

GET Answers?questionID={questionID}&cultureID={cultureID}&questionStatusType={questionStatusType}&includeProperties={includeProperties}

Returns active answers for the specific question provided. The answer will have translated display names in the culture provided.

POST Answers/ParentQuestions

Returns a list of questions that need to be answered for a filtered answer that is dependent on a combination of answers. The input to this method is the ID of the filtered answer question. The returned list contains parent questionIds

POST Answers/Countries

Returns the list of countries for which an answer is valid.

GET Answers/Countries/{countryID}?questionID={questionID}

Return a list of answers valid for a country for a question.

GET Answers/{answerID}/Properties?propertyName={propertyName}

Gets the value of a property for an answer

GET Answers/Priorities

Gets priority values for all answers where the values exist.

POST Answers

Creates a new answer in active status, along with cultures, valid countries and translations.

GET Answers/{answerID}/FilteredAnswers?questionID={questionID}

Returns a list of filtered answers for an answer for a specific question. The returned list contains the ID and display names of an answer.

POST Answers/FilteredAnswers

Returns a list of filtered answers for a specific question based on the combination of a list of answers. The returned list contains the ID and display names of an answer.

GET Answers/DependentQuestionIDs?questionID={questionID}

Returns a list of dependent Questions for the Question

POST Answers/FilteredAnswers/Add

Adds a list of filtered answers for an answer.

DELETE Answers/{answerID}/FilteredAnswers

Removes existing filtered answers.

PUT Answers

Updates the answer. If answer does not exist, it will return ok result.

PUT Answers/{answerID}/Status

Updates the status of an answer and return the question version it belongs to.

PUT Answers/{answerID}/Culture/{cultureID}/Status?isLive={isLive}

Updates the status of answer culture.

POST Answers/{answerID}/Translations

Adds new cultures along with translations to an answer. Throws an error code if all the input cultures exist for an answer.

POST Answers/{answerID}/Properties

Add Properties to an answer

PUT Answers/{answerID}/Properties

Updates properties to an answer

DELETE Answers/{answerID}/Properties

Removes properties of an answer.

PUT Answers/RefreshCache?resetDelta={resetDelta}

Refreshes active answer and active question answers cache.

PUT Answers/RefreshCache/Translation?resetDelta={resetDelta}

Refreshes answer countries, answer translations and cultures caches.

DELETE Answers/{answerID}/Translations

Removes translations for an answer.

GET {authenticationKey}/{version}/Answers/HeartBeat

No documentation available.

QuestionSetQuestionCriteria

APIDescription
GET QuestionSets/{questionSetID}/Questions/{questionID}/Criteria?isLive={isLive}&includeDescription={includeDescription}

Returns a list of criteria for a question in a live questionset.

POST QuestionSets/{questionSetID}/Questions/{questionID}/Criteria

Creates criteria for a question in a questionset.

POST QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/Criterion

Add criterion to the existing criteria for a question in a questionset.

DELETE QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/Criterion?criteriaID={criteriaID}&criterionID={criterionID}

Remove criterion from an existing criteria for a question in a questionset.

PUT QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/Criterion

Update criterion to the existing criteria for a question in a questionset.

DELETE QuestionSets/{questionSetID}/Questions/{questionID}/Criteria?criteriaID={criteriaID}

Deletes a criteria for question in a questionset.

PUT QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/Status?criteriaID={criteriaID}&isLive={isLive}

Updates existing criterion and returns the updated question set version number. Rules of versioning apply to this method.

POST QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/Status

Updates existing criterion and returns the updated question set version number. Rules of versioning apply to this method.

PUT QuestionSets/{questionSetID}/Questions/{questionID}/Criteria/RefreshCache?resetDelta={resetDelta}

Refreshes Cache

GET {authenticationKey}/{version}/QuestionSetQuestionCriteria/HeartBeat

No documentation available.

Sampling

APIDescription
GET Sampling

No documentation available.

POST Sampling/Questions/Bulk

Returns the questions by from the requested collection.

POST Sampling/Questions/Answers

No documentation available.

POST Sampling/Answers

No documentation available.

GET {authenticationKey}/{version}/Sampling/HeartBeat

No documentation available.

TacticalQuestionSets

APIDescription
GET Tactical/QuestionSets

Gets All live Tactical QuestionSets for a specific panel type

GET Tactical/QuestionSets?questionSetID={questionSetID}&includeCultures={includeCultures}&includeQuestions={includeQuestions}&includeProperties={includeProperties}

Returns a live version of the question set. Throws bad request if question set does not exist.

POST Tactical/QuestionSets/ForQuestions

Returns live tactical questionsets for questions

POST Tactical/QuestionSets

Creates a version one of the question set in draft status, along with cultures and translations.

PUT Tactical/QuestionSets

Updates the question set and return the version updated. Rules of versioning apply to this method.

DELETE Tactical/QuestionSets?questionSetID={questionSetID}

Deletes a question set. Throws an error code when trying to delete a live question set.

POST Tactical/QuestionSets/Questions

Adds new questions to question set and returns the version updated. Throws an error code if all the input questions already exist in a questions set. Rules of versioning apply to this method.

POST Tactical/QuestionSets/Questions/Remove

Removes existing questions from a question set and returns the version updated. Throws an error code if all the input questions do not exist in a questions set. Rules of versioning apply to this method.

GET Tactical/QuestionSets/HeartBeat

No documentation available.

BaseQuestionSet

APIDescription
GET {authenticationKey}/{version}/BaseQuestionSet/HeartBeat

No documentation available.