summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md')
-rw-r--r--jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md b/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md
new file mode 100644
index 0000000..167e557
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md
@@ -0,0 +1,33 @@
+# SurveyEligibilityCriterion
+
+Explanatory record of which question answers contributed to a user\'s eligibility for a survey. This is INSUFFICIENT for determining eligibility to a task as it IGNORES logical operators, dependencies between criteria, and other requirements. It is only intended for the UI.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question_id** | **string** | | [default to undefined]
+**property_code** | **string** | | [default to undefined]
+**question_text** | **string** | | [default to undefined]
+**qualifying_answer** | **Array<string>** | User answer(s) that satisfied at least one eligibility rule | [default to undefined]
+**qualifying_answer_label** | **Array<string>** | | [default to undefined]
+**explanation** | **string** | | [optional] [default to undefined]
+**rank** | **number** | | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SurveyEligibilityCriterion } from './api';
+
+const instance: SurveyEligibilityCriterion = {
+ question_id,
+ property_code,
+ question_text,
+ qualifying_answer,
+ qualifying_answer_label,
+ explanation,
+ rank,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)