From 3eaa56f0306ead818f64c3d99fc6d230d9b970a4 Mon Sep 17 00:00:00 2001 From: Max Nanis Date: Wed, 18 Feb 2026 20:42:03 -0500 Subject: HERE WE GO, HERE WE GO, HERE WE GO --- jb-ui/src/api_fsb/docs/ReportApi.md | 64 +++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 jb-ui/src/api_fsb/docs/ReportApi.md (limited to 'jb-ui/src/api_fsb/docs/ReportApi.md') diff --git a/jb-ui/src/api_fsb/docs/ReportApi.md b/jb-ui/src/api_fsb/docs/ReportApi.md new file mode 100644 index 0000000..daaca43 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ReportApi.md @@ -0,0 +1,64 @@ +# ReportApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**reportTaskProductIdReportPost**](#reporttaskproductidreportpost) | **POST** /{product_id}/report/ | Report Task| + +# **reportTaskProductIdReportPost** +> StatusResponse reportTaskProductIdReportPost(reportTask) + +Send a \"Task Report\" for a respondent\'s latest started survey, regardless of the survey\'s outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent\'s task attempt. If a latest attempt can\'t be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it\'s important that the respondent submits a Task Report as soon as possible and applications doesn\'t offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { \'bpuid\': \'1234\', \'reasons\': [2], \'notes\': \"This survey was the worst!\" } Returns {\'status\': \'success\', \'msg\': error_msg} + +### Example + +```typescript +import { + ReportApi, + Configuration, + ReportTask +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ReportApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let reportTask: ReportTask; // + +const { status, data } = await apiInstance.reportTaskProductIdReportPost( + productId, + reportTask +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **reportTask** | **ReportTask**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| + + +### 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) + -- cgit v1.2.3