The Index method returns an array of Surveys owned by the Organization represented by the site_id parameter. An error is thrown if any of the parameters are invalid. The Survey object itself represents the attributes of the Survey itself, its type, the rules by how it functions, and what it allows users to do.
Parameters
Attributes
Name | Type | Description |
|---|---|---|
id | Integer | Id of survey |
name | String | Name of survey |
site_id | Integer | Id of site that the survey belongs to |
created_at | DateTime | Timestamp when created |
updated_at | DateTime | Timestamp of last update |
status | Integer | 0 = Disabled |
tst_rate_group_num | Integer | Code that references the fee setup for the survey |
code | String | Internal reference code |
survey_type | String | registration, group, site_member |
registrar_emails | String | Email addresses receiving notification of each survey completion |
allow_multiple_registrations | Boolean | When true, the survey can be filled out more than once by a given profile |
next_event | Boolean | When true, denotes that the survey is tied to a Next Testing event |
rep_user_id | Integer | Unique ID assigned by Sport Ngin |
monetary | Boolean | When true, the survey is collecting money |
open_date | DateTime | Future date registration will be open to be completed |
close_date | DateTime | Future date registration will no longer be available |
bank_account_id | Integer | Unique ID representing a bank account used for transferring profits |
merchant_account_id | Integer | Unique ID representing a merchant account used to process transactions |
custom_message | String | Message to be displayed on receipt email |
login_optional | Boolean | When true, the user is not required to log in to complete the survey |
user_id | Integer | Unique id representing the user in the Sport Ngin system |
has_barcode | Boolean | When true, denotes that the survey has a barcode associated with it |
barcode_type | String | A field that allows the survey creator to select from a set of standard barcode types |
group_range | Serialized String | Minimum/maximum number of individuals that can fill out a group registration |
group_range_question_element_id | Integer | Id of QuestionElement that is used to determine group_range |
editable_by_user | Boolean | When true, denotes that the survey is editable by the user after submission |
form_label | String | Group/team label for group registrations |
sub_form_label | String | Individual/player label for group registrations |
custom_css | String | ???Custom css to adjust the look of the survey??? NOT NEEDED? |
user_can_add_entries | Boolean | When true, denotes that the user can add their own entries to the survey after it has been completed |
skip_welcome_page | Boolean | When true, denotes that the survey will skip the welcome page and start on the first question form |
event_id | Integer | Id of event that is associated with the survey |
customer_pays_fee | Boolean | When true, denotes that the customer will pay the transaction and processing fees |
offer_id | Integer | ??REMOVE??? Not used. |
allow_amex | Boolean | When true, denotes that the user can pay using American Express |
next_form_text_override | String | ???REMOVE??? Next testing. |
restrict_invite | Boolean | When true, denotes that the survey will not automatically invite unregistered users |
background_screen_enabled | Boolean | When true, denotes that the survey is a background screen |
approval_user_id | Integer | ???Sport Ngin user ID of survey admin???NEEDED? |