1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
# 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)
|
