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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
# ContestApi
All URIs are relative to *https://fsb.generalresearch.com*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getContestUserViewProductIdContestContestUuidUserProductUserIdGet**](#getcontestuserviewproductidcontestcontestuuiduserproductuseridget) | **GET** /{product_id}/contest/{contest_uuid}/user/{product_user_id}/ | Get Contest User View|
|[**listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet**](#listcontestsusereligibleproductidcontestuserproductuserideligibleget) | **GET** /{product_id}/contest/user/{product_user_id}/eligible/ | List Contests User Eligible|
|[**listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet**](#listcontestsuserenteredproductidcontestuserproductuseridenteredget) | **GET** /{product_id}/contest/user/{product_user_id}/entered/ | List Contests User Entered|
|[**listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet**](#listcontestsuserwinnerproductidcontestuserproductuseridwinnerget) | **GET** /{product_id}/contest/user/{product_user_id}/winner/ | List Contests User Winner|
# **getContestUserViewProductIdContestContestUuidUserProductUserIdGet**
> ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet getContestUserViewProductIdContestContestUuidUserProductUserIdGet()
Gets a Contest. Includes several keys that are specific to the requesting user: e.g. user_winnings, user_amount.
### Example
```typescript
import {
ContestApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContestApi(configuration);
let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let contestUuid: string; // (default to undefined)
let productUserId: 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)
const { status, data } = await apiInstance.getContestUserViewProductIdContestContestUuidUserProductUserIdGet(
productId,
contestUuid,
productUserId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **contestUuid** | [**string**] | | defaults to undefined|
| **productUserId** | [**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|
### Return type
**ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet**
### 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)
# **listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet**
> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet()
Get contests the requesting user is eligible for. Contest eligibility may involve the user\'s country, which is determined by the ip address of THIS request.
### Example
```typescript
import {
ContestApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContestApi(configuration);
let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let productUserId: 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)
const { status, data } = await apiInstance.listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet(
productId,
productUserId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **productUserId** | [**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|
### Return type
**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>**
### 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)
# **listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet**
> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet()
Get contests the requesting user has entered. This includes contests such as milestone contests where the user was automatically entered by having a complete for instance.
### Example
```typescript
import {
ContestApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContestApi(configuration);
let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let productUserId: 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)
const { status, data } = await apiInstance.listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet(
productId,
productUserId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **productUserId** | [**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|
### Return type
**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>**
### 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)
# **listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet**
> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet()
Get contests the requesting user has won a prize for.
### Example
```typescript
import {
ContestApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ContestApi(configuration);
let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let productUserId: 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)
const { status, data } = await apiInstance.listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet(
productId,
productUserId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **productUserId** | [**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|
### Return type
**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>**
### 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)
|
