summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/TaskStatusResponse.md
blob: 68baace04dd6e2b04567c3ca99e0d58c1cb23471 (plain)
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
# TaskStatusResponse

The status of a session

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tsid** | **string** | A unique identifier for the session | [default to undefined]
**product_id** | **string** | The BP ID of the associated respondent | [default to undefined]
**product_user_id** | **string** | A unique identifier for each user, which is set by the Supplier | [default to undefined]
**started** | **string** | When the session was started | [default to undefined]
**finished** | **string** |  | [optional] [default to undefined]
**status** | **number** | The outcome of a session.   - 0 - UNKNOWN   - 1 - ENTER (the user has not yet returned)   - 2 - INCOMPLETE (the user failed)   - 3 - COMPLETE (the user completed the task) | [optional] [default to undefined]
**payout** | **number** |  | [optional] [default to undefined]
**user_payout** | **number** |  | [optional] [default to undefined]
**payout_format** | **string** |  | [optional] [default to undefined]
**user_payout_string** | **string** |  | [optional] [default to undefined]
**kwargs** | **{ [key: string]: string; }** | Any extra url params used in the offerwall request will be passed back here | [optional] [default to undefined]
**status_code_1** | **string** |  | [optional] [default to undefined]
**status_code_2** | **string** |  | [optional] [default to undefined]
**adjusted_status** | [**SessionAdjustedStatus**](SessionAdjustedStatus.md) |  | [optional] [default to undefined]
**adjusted_timestamp** | **string** |  | [optional] [default to undefined]
**adjusted_payout** | **number** |  | [optional] [default to undefined]
**adjusted_user_payout** | **number** |  | [optional] [default to undefined]
**adjusted_user_payout_string** | **string** |  | [optional] [default to undefined]
**wall_events** | [**Array<WallOut>**](WallOut.md) |  | [optional] [default to undefined]
**currency** | **string** |  | [optional] [default to CurrencyEnum_Usd]
**final_status** | **number** | This is deprecated | [optional] [default to 0]
**bpuid** | **string** |  | [readonly] [default to undefined]

## Example

```typescript
import { TaskStatusResponse } from './api';

const instance: TaskStatusResponse = {
    tsid,
    product_id,
    product_user_id,
    started,
    finished,
    status,
    payout,
    user_payout,
    payout_format,
    user_payout_string,
    kwargs,
    status_code_1,
    status_code_2,
    adjusted_status,
    adjusted_timestamp,
    adjusted_payout,
    adjusted_user_payout,
    adjusted_user_payout_string,
    wall_events,
    currency,
    final_status,
    bpuid,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)