flywheel.models.form_response_base
FormResponseBase
Bases: object
data property writable
Gets the data of this FormResponseBase.
User's form input data
Returns:
| Type | Description |
|---|---|
dict(str, object) | The data of this FormResponseBase |
modified property writable
Gets the modified of this FormResponseBase.
Last modification timestamp
Returns:
| Type | Description |
|---|---|
datetime | The modified of this FormResponseBase |
protocol_id property writable
Gets the protocol_id of this FormResponseBase.
ID of the protocol this response is for
Returns:
| Type | Description |
|---|---|
str | The protocol_id of this FormResponseBase |
submitted property writable
Gets the submitted of this FormResponseBase.
Whether the response has been submitted
Returns:
| Type | Description |
|---|---|
bool | The submitted of this FormResponseBase |
submitted_at property writable
Gets the submitted_at of this FormResponseBase.
Timestamp of submission if submitted
Returns:
| Type | Description |
|---|---|
datetime | The submitted_at of this FormResponseBase |
task_id property writable
Gets the task_id of this FormResponseBase.
ID of the task this response is linked to
Returns:
| Type | Description |
|---|---|
str | The task_id of this FormResponseBase |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(task_id=None, protocol_id=None, data=None, submitted=None, submitted_at=None, modified=None)
FormResponseBase - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id | (str, optional) | ID of the task this response is linked to, defaults to None | None |
protocol_id | (str, optional) | ID of the protocol this response is for, defaults to None | None |
data | (dict(str, object), optional) | User's form input data, defaults to None | None |
submitted | (bool, optional) | Whether the response has been submitted, defaults to None | None |
submitted_at | (datetime, optional) | Timestamp of submission if submitted, defaults to None | None |
modified | (datetime, optional) | Last modification timestamp, defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object