diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md b/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md new file mode 100644 index 0000000..384011a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md @@ -0,0 +1,264 @@ +# ProfilingQuestionsApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getProfilingQuestionsProductIdProfilingQuestionsGet**](#getprofilingquestionsproductidprofilingquestionsget) | **GET** /{product_id}/profiling-questions/ | Get Profiling Questions| +|[**profilingInfoProductIdProfilingInfoGet**](#profilinginfoproductidprofilinginfoget) | **GET** /{product_id}/profiling-info/ | Profiling Info| +|[**submitProfilingQuestionsProductIdProfilingQuestionsPost**](#submitprofilingquestionsproductidprofilingquestionspost) | **POST** /{product_id}/profiling-questions/ | Submit Profiling Questions| +|[**userProfileProductIdUserProfileGet**](#userprofileproductiduserprofileget) | **GET** /{product_id}/user-profile/ | User Profile| + +# **getProfilingQuestionsProductIdProfilingQuestionsGet** +> UpkQuestionResponse getProfilingQuestionsProductIdProfilingQuestionsGet() + +Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) +let limit: number; //Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions\' importance. (optional) (default to undefined) +let isGrs: boolean; //If it\'s the GRS system. (optional) (default to false) + +const { status, data } = await apiInstance.getProfilingQuestionsProductIdProfilingQuestionsGet( + productId, + bpuid, + ip, + countryIso, + languageIso, + limit, + isGrs +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **limit** | [**number**] | Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions\' importance. | (optional) defaults to undefined| +| **isGrs** | [**boolean**] | If it\'s the GRS system. | (optional) defaults to false| + + +### Return type + +**UpkQuestionResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **profilingInfoProductIdProfilingInfoGet** +> ProfilingInfoResponse profilingInfoProductIdProfilingInfoGet() + +Get UPK Ontology (list of properties, property info, and allowed values) + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) + +const { status, data } = await apiInstance.profilingInfoProductIdProfilingInfoGet( + productId, + countryIso, + languageIso +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| + + +### Return type + +**ProfilingInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **submitProfilingQuestionsProductIdProfilingQuestionsPost** +> StatusResponse submitProfilingQuestionsProductIdProfilingQuestionsPost(bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost) + +Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration, + BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) +let bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost; // +let sessionId: string; //The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. (optional) (default to undefined) +let async: boolean; //For internal use. (optional) (default to true) + +const { status, data } = await apiInstance.submitProfilingQuestionsProductIdProfilingQuestionsPost( + productId, + bpuid, + bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, + sessionId, + async +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost** | **BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| +| **sessionId** | [**string**] | The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. | (optional) defaults to undefined| +| **async** | [**boolean**] | For internal use. | (optional) defaults to true| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userProfileProductIdUserProfileGet** +> UserInfoResponse userProfileProductIdUserProfileGet() + + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) + +const { status, data } = await apiInstance.userProfileProductIdUserProfileGet( + productId, + bpuid, + countryIso, + languageIso +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| + + +### Return type + +**UserInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + |