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
|
# ProductUserApi
All URIs are relative to *https://fsb.generalresearch.com*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet**](#userprofilefilterbymarketplacepidproductiduserbymarketplacepidget) | **GET** /{product_id}/user/by-marketplace-pid/ | User Profile Filter By Marketplace Pid|
|[**userProfileProductIdUserProductUserIdProfileGet**](#userprofileproductiduserproductuseridprofileget) | **GET** /{product_id}/user/{product_user_id}/profile/ | User Profile|
|[**userProfileUpdateProductIdUserProductUserIdProfilePatch**](#userprofileupdateproductiduserproductuseridprofilepatch) | **PATCH** /{product_id}/user/{product_user_id}/profile/ | User Profile Update|
# **userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet**
> UserProfilesResponse userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet()
### Example
```typescript
import {
ProductUserApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProductUserApi(configuration);
let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined)
let source: Source; //The marketplace to search (default to undefined)
let pid: Array<string>; //The user\'s marketplace PID. Supports multiple params (default to undefined)
const { status, data } = await apiInstance.userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet(
productId,
source,
pid
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined|
| **source** | **Source** | The marketplace to search | defaults to undefined|
| **pid** | **Array<string>** | The user\'s marketplace PID. Supports multiple params | defaults to undefined|
### Return type
**UserProfilesResponse**
### 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)
# **userProfileProductIdUserProductUserIdProfileGet**
> UserProfileResponse userProfileProductIdUserProductUserIdProfileGet()
### Example
```typescript
import {
ProductUserApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProductUserApi(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.userProfileProductIdUserProductUserIdProfileGet(
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
**UserProfileResponse**
### 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)
# **userProfileUpdateProductIdUserProductUserIdProfilePatch**
> StatusResponse userProfileUpdateProductIdUserProductUserIdProfilePatch(userProfileUpdateRequest)
### Example
```typescript
import {
ProductUserApi,
Configuration,
UserProfileUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProductUserApi(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)
let userProfileUpdateRequest: UserProfileUpdateRequest; //
const { status, data } = await apiInstance.userProfileUpdateProductIdUserProductUserIdProfilePatch(
productId,
productUserId,
userProfileUpdateRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **userProfileUpdateRequest** | **UserProfileUpdateRequest**| | |
| **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
**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)
|
