# StatusApi

All URIs are relative to *https://fsb.generalresearch.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getTaskStatusProductIdStatusTsidGet**](#gettaskstatusproductidstatustsidget) | **GET** /{product_id}/status/{tsid}/ | Get Task Status|
|[**listTaskStatusesProductIdStatusGet**](#listtaskstatusesproductidstatusget) | **GET** /{product_id}/status/ | List Task Statuses|

# **getTaskStatusProductIdStatusTsidGet**
> TaskStatusResponse getTaskStatusProductIdStatusTsidGet()

Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect.  Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session.

### Example

```typescript
import {
    StatusApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new StatusApi(configuration);

let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let tsid: string; //A unique identifier for the session (default to undefined)

const { status, data } = await apiInstance.getTaskStatusProductIdStatusTsidGet(
    productId,
    tsid
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **tsid** | [**string**] | A unique identifier for the session | defaults to undefined|


### Return type

**TaskStatusResponse**

### 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 |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**500** | Internal Server Error |  -  |
|**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)

# **listTaskStatusesProductIdStatusGet**
> TasksStatusResponse listTaskStatusesProductIdStatusGet()


### Example

```typescript
import {
    StatusApi,
    Configuration,
    StartedAfter,
    StartedBefore,
    AdjustedAfter,
    AdjustedBefore
} from './api';

const configuration = new Configuration();
const apiInstance = new StatusApi(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. Filters the returned task status to only include those done by this user. (optional) (default to undefined)
let startedAfter: StartedAfter; //Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. (optional) (default to undefined)
let startedBefore: StartedBefore; //Retrieve sessions which were started before this timestamp. If `NULL`, default is now. (optional) (default to undefined)
let status: number; //Filter for sessions with this status. See Task Status for description of status. (optional) (default to undefined)
let reconciled: boolean; //Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. (optional) (default to false)
let adjustedAfter: AdjustedAfter; //Retrieve sessions which were adjusted after this timestamp. (optional) (default to undefined)
let adjustedBefore: AdjustedBefore; //Retrieve sessions which were adjusted before this timestamp. Default is now. (optional) (default to undefined)
let orderBy: string; //Comma-separated fields to order by (optional) (default to '-started')
let page: number; // (optional) (default to 1)
let size: number; // (optional) (default to 50)

const { status, data } = await apiInstance.listTaskStatusesProductIdStatusGet(
    productId,
    bpuid,
    startedAfter,
    startedBefore,
    status,
    reconciled,
    adjustedAfter,
    adjustedBefore,
    orderBy,
    page,
    size
);
```

### 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. Filters the returned task status to only include those done by this user. | (optional) defaults to undefined|
| **startedAfter** | **StartedAfter** | Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. | (optional) defaults to undefined|
| **startedBefore** | **StartedBefore** | Retrieve sessions which were started before this timestamp. If `NULL`, default is now. | (optional) defaults to undefined|
| **status** | [**number**] | Filter for sessions with this status. See Task Status for description of status. | (optional) defaults to undefined|
| **reconciled** | [**boolean**] | Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. | (optional) defaults to false|
| **adjustedAfter** | **AdjustedAfter** | Retrieve sessions which were adjusted after this timestamp. | (optional) defaults to undefined|
| **adjustedBefore** | **AdjustedBefore** | Retrieve sessions which were adjusted before this timestamp. Default is now. | (optional) defaults to undefined|
| **orderBy** | [**string**] | Comma-separated fields to order by | (optional) defaults to '-started'|
| **page** | [**number**] |  | (optional) defaults to 1|
| **size** | [**number**] |  | (optional) defaults to 50|


### Return type

**TasksStatusResponse**

### 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 |  -  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**500** | Internal Server Error |  -  |
|**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)