getAllQuestionnaires
- Description
- This inquiry transaction returns the details of all existing Questionnaires in a given language.
- Web Services
- Operation name: getAllQuestionnaires
- Example
- Retrieve all active Questionnaires that use the English language.
- Usage information
- This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- LanguageTypeCode
- InquiryLevel
- Filter
- Inquiry levels
- InquiryLevel:
- Level 0 - returns QuestionnaireBObj objects only.
- Level 1 - returns level 0 data plus all QuestionBObj objects and EnumeratedAnswerBObj objects.
- Filter values
- This transaction requires a filter value. Valid values are:
- ACTIVE – returns active records only.
- INACTIVE – returns inactive records only.
- ALL – returns all records that match the search criteria, both active and inactive.
If the filter value provided is incorrect, all records that match the search criteria, both active and inactive, are returned by default.
- Transaction behavior
- Questionnaires with a StartDate on or before the current date
and an EndDate after the current date are "Active".
Questionnaires with an EndDate before the current date are "Inactive".
- Request message
- <InquiryType> getAllQuestionnaires
<InquiryParam>
<tcrmParam name = "languageTypeCode">
<tcrmParam name = "inquiryLevel">
<tcrmParam name = "filter">
- Response objects
- QuestionnaireBObj details, based on the LanguageTypeCode, Filter,
and InquiryLevel value:
- 0 - one or more QuestionnaireBObj objects
- 1 - level 0 data plus associated QuestionBObj objects with their associated EnumeratedAnswerBObj objects
- Special note
- Not applicable