| | |
44 | Methods defined here:
45 | - __init__(self, apiKey, debug=False, outputType='json')
46 |
47 | - clone_form(self, formID)
- Clone a single form.
48 |
49 | Args:
50 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
51 |
52 | Returns:
53 | Status of request.
54 |
55 | - create_conditions(self, offset, limit, filterArray, order_by)
56 |
57 | - create_form_submissions(self, formID, submission)
- Submit data to this form using the API.
58 |
59 | Args:
60 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
61 | submission (array): Submission data with question IDs.
62 |
63 | Returns:
64 | Posted submission ID and URL.
65 |
66 | - create_form_webhook(self, formID, webhookURL)
- Add a new webhook
67 |
68 | Args:
69 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
70 | webhookURL (string): Webhook URL is where form data will be posted when form is submitted.
71 |
72 | Returns:
73 | List of webhooks for a specific form.
74 |
75 | - delete_form_question(self, formID, qid)
- Delete a single form question.
76 |
77 | Args:
78 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
79 | qid (string): Identifier for each question on a form. You can get a list of question IDs from /form/{id}/questions.
80 |
81 | Returns:
82 | Status of request.
83 |
84 | - delete_submission(self, sid)
- Delete a single submission.
85 |
86 | Args:
87 | sid (string): You can get submission IDs when you call /form/{id}/submissions.
88 |
89 | Returns:
90 | Status of request.
91 |
92 | - edit_submission(self, sid, submission)
- Edit a single submission.
93 |
94 | Args:
95 | sid (string): You can get submission IDs when you call /form/{id}/submissions.
96 | submission (array): New submission data with question IDs.
97 |
98 | Returns:
99 | Status of request.
100 |
101 | - fetch_url(self, url, params=None, method=None)
102 |
103 | - get_folder(self, folderID)
- Get folder details
104 |
105 | Args:
106 | folderID (string): Get a list of folders from /user/folders
107 |
108 | Returns:
109 | A list of forms in a folder, and other details about the form such as folder color.
110 |
111 | - get_folders(self)
- Get a list of form folders for this account.
112 |
113 | Returns:
114 | Name of the folder and owner of the folder for shared folders.
115 |
116 | - get_form(self, formID)
- Get basic information about a form.
117 |
118 | Args:
119 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
120 |
121 | Returns:
122 | Form ID, status, update and creation dates, submission count etc.
123 |
124 | - get_form_files(self, formID)
- List of files uploaded on a form.
125 |
126 | Args:
127 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
128 |
129 | Returns:
130 | Uploaded file information and URLs on a specific form.
131 |
132 | - get_form_properties(self, formID)
- Get a list of all properties on a form.
133 |
134 | Args:
135 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
136 |
137 | Returns:
138 | Form properties like width, expiration date, style etc.
139 |
140 | - get_form_property(self, formID, propertyKey)
- Get a specific property of the form.
141 |
142 | Args:
143 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
144 | propertyKey (string): You can get property keys when you call /form/{id}/properties.
145 |
146 | Returns:
147 | Given property key value.
148 |
149 | - get_form_question(self, formID, qid)
- Get details about a question
150 |
151 | Args:
152 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
153 | qid (string): Identifier for each question on a form. You can get a list of question IDs from /form/{id}/questions.
154 |
155 | Returns:
156 | Question properties like required and validation.
157 |
158 | - get_form_questions(self, formID)
- Get a list of all questions on a form.
159 |
160 | Args:
161 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
162 |
163 | Returns:
164 | Question properties of a form.
165 |
166 | - get_form_submissions(self, formID, offset=None, limit=None, filterArray=None, order_by=None)
- List of a form submissions.
167 |
168 | Args:
169 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
170 | offset (string): Start of each result set for form list. (optional)
171 | limit (string): Number of results in each result set for form list. (optional)
172 | filterArray (array): Filters the query results to fetch a specific form range.(optional)
173 | order_by (string): Order results by a form field name. (optional)
174 |
175 | Returns:
176 | Submissions of a specific form.
177 |
178 | - get_form_webhooks(self, formID)
- Get list of webhooks for a form
179 |
180 | Args:
181 | formID (string): Form ID is the numbers you see on a form URL. You can get form IDs when you call /user/forms.
182 |
183 | Returns:
184 | List of webhooks for a specific form.
185 |
186 | - get_forms(self, offset=None, limit=None, filterArray=None, order_by=None)
- Get a list of forms for this account
187 |
188 | Args:
189 | offset (string): Start of each result set for form list. (optional)
190 | limit (string): Number of results in each result set for form list. (optional)
191 | filterArray (array): Filters the query results to fetch a specific form range.(optional)
192 | order_by (string): Order results by a form field name. (optional)
193 |
194 | Returns:
195 | Basic details such as title of the form, when it was created, number of new and total submissions.
196 |
197 | - get_history(self)
- Get user activity log.
198 |
199 | Returns:
200 | Activity log about things like forms created/modified/deleted, account logins and other operations.
201 |
202 | - get_report(self, reportID)
- Get report details
203 |
204 | Args:
205 | reportID (string): You can get a list of reports from /user/reports.
206 |
207 | Returns:
208 | Properties of a speceific report like fields and status.
209 |
210 | - get_reports(self)
- List of URLS for reports in this account.
211 |
212 | Returns:
213 | Reports for all of the forms. ie. Excel, CSV, printable charts, embeddable HTML tables.
214 |
215 | - get_settings(self)
- Get user's settings for this account.
216 |
217 | Returns:
218 | User's time zone and language.
219 |
220 | - get_submission(self, sid)
- Get submission data
221 |
222 | Args:
223 | sid (string): You can get submission IDs when you call /form/{id}/submissions.
224 |
225 | Returns:
226 | Information and answers of a specific submission.
227 |
228 | - get_submissions(self, offset=None, limit=None, filterArray=None, order_by=None)
- Get a list of submissions for this account.
229 |
230 | Args:
231 | offset (string): Start of each result set for form list. (optional)
232 | limit (string): Number of results in each result set for form list. (optional)
233 | filterArray (array): Filters the query results to fetch a specific form range.(optional)
234 | order_by (string): Order results by a form field name. (optional)
235 |
236 | Returns:
237 | Basic details such as title of the form, when it was created, number of new and total submissions.
238 |
239 | - get_subusers(self)
- Get a list of sub users for this account.
240 |
241 | Returns:
242 | List of forms and form folders with access privileges.
243 |
244 | - get_usage(self)
- Get number of form submissions received this month.
245 |
246 | Returns:
247 | Number of submissions, number of SSL form submissions, payment form submissions and upload space used by user.
248 |
249 | - get_user(self)
- Get user account details for a JotForm user.
250 |
251 | Returns:
252 | User account type, avatar URL, name, email, website URL and account limits.
253 |
254 | |